From 8821d6b6494ae354cd432ea20f57291382504d2b Mon Sep 17 00:00:00 2001 From: spekary Date: Wed, 2 Mar 2022 09:32:58 -0800 Subject: [PATCH] Updating PR template to reflect new contribution guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2fb9de39..4c313f1f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,15 +9,18 @@ **Note**: _that new categories can be added only when there are 3 packages or more._ -**Make sure that you've checked the boxes below before you submit PR:** -_not every repository (project) will fit into every option, but most projects should_ +**Make sure that you've checked the boxes below that apply before you submit PR.** +_Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for detials._ -- [ ] I have added my package in alphabetical order. -- [ ] I have an appropriate description with correct grammar. -- [ ] I know that this package was not listed before. -- [ ] I have added pkg.go.dev link to the repo and to my pull request. -- [ ] I have added coverage service link to the repo and to my pull request. -- [ ] I have added goreportcard link to the repo and to my pull request. -- [ ] I have read [Contribution guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines), [maintainers note](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#maintainers) and [Quality standard](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards). +- [ ] The package has been added to the list in alphabetical order. +- [ ] The package has an appropriate description with correct grammar. +- [ ] As far as I know, the package has not been listed here before. +- [ ] The repo documentation has a pkg.go.dev link. +- [ ] The repo documentation has a coverage service link. +- [ ] The repo documenation has a goreportcard link. +- [ ] The repo has a version-numbered release and a go.mod file. +- [ ] I have read the [Contribution Guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines), [Maintainers Note](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#maintainers) and [Quality Standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards). +- [ ] The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged. +- [ ] The authors of the project do not commit directly to the repo, but rather use pull-requests that run the continuous-integration process. Thanks for your PR, you're awesome! :+1: