|
1 | | -> Please check if what you want to add to `awesome-go` list meets [quality standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards) before sending pull request. Thanks! |
| 1 | +## Required links |
2 | 2 |
|
3 | | -**Please provide package links to:** |
| 3 | +_Provide the links below. Our CI will automatically validate them._ |
4 | 4 |
|
5 | | -- repo link (github.com, gitlab.com, etc): |
6 | | -- pkg.go.dev: |
7 | | -- goreportcard.com: |
8 | | -- coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), etc.): |
| 5 | +- [ ] Forge link (github.com, gitlab.com, etc): <!-- https://github.com/org/project --> |
| 6 | +- [ ] pkg.go.dev: <!-- https://pkg.go.dev/github.com/org/project --> |
| 7 | +- [ ] goreportcard.com: <!-- https://goreportcard.com/report/github.com/org/project --> |
| 8 | +- [ ] Coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), etc.): <!-- https://app.codecov.io/gh/org/project --> |
9 | 9 |
|
10 | | -**Note**: _that new categories can be added only when there are 3 packages or more._ |
| 10 | +## Pre-submission checklist |
11 | 11 |
|
12 | | -**Make sure that you've checked the boxes below that apply before you submit PR.** |
13 | | -_Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details._ |
| 12 | +- [ ] I have read the [Contribution Guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines) |
| 13 | +- [ ] I have read the [Quality Standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards) |
14 | 14 |
|
15 | | -- [ ] The package has been added to the list in alphabetical order. |
16 | | -- [ ] The package has an appropriate description with correct grammar. |
17 | | -- [ ] As far as I know, the package has not been listed here before. |
| 15 | +## Repository requirements |
| 16 | + |
| 17 | +_These are validated automatically by CI:_ |
| 18 | + |
| 19 | +- [ ] The repo has a `go.mod` file and at least one SemVer release (`vX.Y.Z`). |
| 20 | +- [ ] The repo has an open source license. |
18 | 21 | - [ ] The repo documentation has a pkg.go.dev link. |
| 22 | +- [ ] The repo documentation has a goreportcard link (grade A- or better). |
19 | 23 | - [ ] The repo documentation has a coverage service link. |
20 | | -- [ ] The repo documentation has a goreportcard link. |
21 | | -- [ ] The repo has a version-numbered release and a go.mod file. |
22 | | -- [ ] 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). |
23 | | -- [ ] The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged. |
24 | | -- [ ] Continuous integration is used to attempt to catch issues prior to releasing this package to end-users. |
25 | 24 |
|
26 | | -Thanks for your PR, you're awesome! :+1: |
| 25 | +_These are recommended and reported as warnings:_ |
| 26 | + |
| 27 | +- [ ] The repo has a continuous integration process (GitHub Actions, etc.). |
| 28 | +- [ ] CI runs tests that must pass before merging. |
| 29 | + |
| 30 | +## Pull Request content |
| 31 | + |
| 32 | +_These are validated automatically by CI:_ |
| 33 | + |
| 34 | +- [ ] This PR adds/removes/changes **only one** package. |
| 35 | +- [ ] The package has been added in **alphabetical order**. |
| 36 | +- [ ] The link text is the **exact project name**. |
| 37 | +- [ ] The description is clear, concise, non-promotional, and **ends with a period**. |
| 38 | +- [ ] The link in README.md matches the forge link above. |
| 39 | + |
| 40 | +## Category quality |
| 41 | + |
| 42 | +_Note: new categories require a minimum of 3 packages._ |
| 43 | + |
| 44 | +Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure they still meet the Quality Standards. |
| 45 | + |
| 46 | +Please delete one of the following lines: |
| 47 | + |
| 48 | +- [ ] The packages around my addition still meet the Quality Standards. |
| 49 | +- [ ] I removed the following packages around my addition: (please give a short reason for each removal) |
| 50 | + |
| 51 | +Thanks for your PR, you're awesome! :sunglasses: |
0 commit comments