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 #484 from avelino/quality-standards

Browse Source 
Clarifications to quality standards
This commit is contained in:
Thiago Avelino 2015-08-03 02:07:30 -03:00
commit 9ba1868052
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -20,16 +20,22 @@ Please contribute links to packages/projects you have used or are familiar with.
## Quality standard
To stay on the list, package repositories should adhere to these quality standards:
To be on the list, project repositories should adhere to these quality standards:
- Generally useful to the community
- Functional
- Actively maintained (even if that just means acknowledging open issues when they arise)
- Stable, or progressing toward stable
- Documented (preferably godoc.org)
- Tests are preferred (when possible)
- Code functions as documented and expected
- Generally useful to the wider community of Go programmers
- Actively maintained
- Regular, recent commits
- Or, for finished projects, issues and pull requests are responded to
- Stable or progressing toward stable
- Thoroughly documented (README, godoc comments, etc.)
- Tests, where practical
## Reporting issues
Please open an issue if you would like ot discuss anything that could be improved or have suggestions for making the list a more valuable resource. We realize sometimes packages fall into abandonment or have breaking builds for extended periods of time, so if you see that, feel free to make the change or let us know. We also realize that sometimes projects are just going through transitions or are more experimental in nature. These can still be cool, but we can indicate them as transitory or experimental. Thanks everyone!
Please open an issue if you would like ot discuss anything that could be improved or have suggestions for making the list a more valuable resource. We realize sometimes packages fall into abandonment or have breaking builds for extended periods of time, so if you see that, feel free to change its listing or let us know. We also realize that sometimes projects are just going through transitions or are more experimental in nature. These can still be cool, but we can indicate them as transitory or experimental.
Removal changes will not be applied until they have been pending for a minimum of 1 week (7 days). This grace window benefits projects that may be going through a temporary transition but are otherwise worthy of being on the list.
Thanks everyone!