From d2a09b2f7cc69b7f15d903715e2417a5ddb37af0 Mon Sep 17 00:00:00 2001 From: Marcelo Trylesinski Date: Fri, 28 Jan 2022 18:12:31 +0100 Subject: [PATCH 1/4] Add PR template --- .github/pull_request_template.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..20f34b2e1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +## Checklist + +- [ ] I've updated the documentation. +- [ ] I've added tests. +- [ ] I've added an entry to the release-notes.md file. From 80b3af5cac60a64429799c695aebf36f2664bc3f Mon Sep 17 00:00:00 2001 From: Marcelo Trylesinski Date: Fri, 28 Jan 2022 18:13:46 +0100 Subject: [PATCH 2/4] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 20f34b2e1..ef34dc02b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,4 +2,4 @@ - [ ] I've updated the documentation. - [ ] I've added tests. -- [ ] I've added an entry to the release-notes.md file. +- [ ] I've added an entry to the `docs/release-notes.md` file. From 5c9cc38b96a994aeffc29deb9c6f372fe8f8ed82 Mon Sep 17 00:00:00 2001 From: Marcelo Trylesinski Date: Mon, 31 Jan 2022 10:42:52 +0100 Subject: [PATCH 3/4] Update .github/pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ef34dc02b..00f07573c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,4 +2,4 @@ - [ ] I've updated the documentation. - [ ] I've added tests. -- [ ] I've added an entry to the `docs/release-notes.md` file. +- [ ] I've added an entry to the `docs/release-notes.md` file. No need if the PR is a typo fix, type annotation or just adding docs. From 3e7e015d943e32c0728d56dc5b1ce9cc99b3649e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 15 Feb 2022 09:25:11 +0000 Subject: [PATCH 4/4] Update pull_request_template.md --- .github/pull_request_template.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 00f07573c..45debc642 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,7 @@ -## Checklist +The starting point for contributions should usually be [a discussion](https://github.com/encode/httpx/discussions) -- [ ] I've updated the documentation. -- [ ] I've added tests. -- [ ] I've added an entry to the `docs/release-notes.md` file. No need if the PR is a typo fix, type annotation or just adding docs. +Simple documentation typos may be raised as stand-alone pull requests, but otherwise please ensure you've discussed your proposal prior to issuing a pull request. + +This will help us direct work appropriately, and ensure that any suggested changes have been okayed by the maintainers. + +- [ ] Initially raised as discussion #...