awesome/awesome-go
1
0
Fork 0
mirror of https://github.com/avelino/awesome-go.git synced 2024-12-12 17:13:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1296 from alrux-devops/edit-CONTRIBUTING.md

Browse Source 
minor fixes to CONTRIBUTING.md
This commit is contained in:
Kirill Danshin 2017-02-19 01:16:43 +03:00 committed by GitHub
commit a3a1f09d67
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -7,21 +7,21 @@ Join us on IRC at **#awesome-go** on freenode [web access](http://webchat.freeno
- **To add, remove, or change things on the list:** Submit a pull request - **To add, remove, or change things on the list:** Submit a pull request
To set this list apart from and compliment the excellent [Go wiki Projects page](https://golang.org/wiki/Projects), awesome-go is a specially curated list for high-quality, actively maintained Go packages and resources. To set this list apart from and complement the excellent [Go wiki Projects page](https://golang.org/wiki/Projects), awesome-go is a specially curated list for high-quality, actively maintained Go packages and resources.
- List items should be sorted *alphabetically*. - List items should be sorted *alphabetically*.
- Each item should be limited to one link - Each item should be limited to one link.
- The link should be the name of the package or project - The link should be the name of the package or project.
- Descriptions should be clear, concise, and non-promotional - Descriptions should be clear, concise, and non-promotional.
- Descriptions should follow the link, on the same line - Descriptions should follow the link, on the same line.
- Needs library 3 (minimum) to create a new category. - At least 3 items are needed to create a new category.
Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries. Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.
If you removed our PR template you can find it [here](https://github.com/avelino/awesome-go/blob/master/.github/PULL_REQUEST_TEMPLATE.md). If you removed our PR template you can find it [here](https://github.com/avelino/awesome-go/blob/master/.github/PULL_REQUEST_TEMPLATE.md).
## Quality standard ## Quality standards
To be on the list, project repositories should adhere to these quality standards (http://goreportcard.com/report/**github_user**/**github_repo**): To be on the list, project repositories should adhere to these quality standards (http://goreportcard.com/report/**github_user**/**github_repo**):
@ -32,7 +32,7 @@ To be on the list, project repositories should adhere to these quality standards
- Or, for finished projects, issues and pull requests are responded to - Or, for finished projects, issues and pull requests are responded to
- Stable or progressing toward stable - Stable or progressing toward stable
- Thoroughly documented (README, godoc comments, etc.) - Thoroughly documented (README, godoc comments, etc.)
- Tests, where practical. If library/program testable, than coverage should be >= 80% for non-data-related packages and >=90% for data related packages. **Notice**: the tests will be reviewed too. We will check your coverage manually if your package's coverage is just a benchmark results. - Tests, where practical. If the library/program is testable, then coverage should be >= 80% for non-data-related packages and >=90% for data related packages. **Notice**: the tests will be reviewed too. We will check your coverage manually if your package's coverage is just a benchmark results.
## Reporting issues ## Reporting issues