mirror of
https://github.com/avelino/awesome-go.git
synced 2024-12-12 17:13:58 +00:00
rebasing README.md
This commit is contained in:
commit
1a72c8ba29
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
6
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
Please check if what you want to add to `awesome-go` list meets [quality standards](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standard) before sending pull request. Thanks!
|
||||||
|
|
||||||
|
Please provide package links to:
|
||||||
|
- godoc.org:
|
||||||
|
- goreportcard.com:
|
||||||
|
- gocover.io:
|
@ -14,13 +14,14 @@ To set this list apart from and compliment the excellent [Go wiki Projects page]
|
|||||||
- 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 bibliotica 3 (minimum) 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.
|
||||||
|
|
||||||
|
|
||||||
## Quality standard
|
## Quality standard
|
||||||
|
|
||||||
To be on the list, project repositories should adhere to these quality standards:
|
To be on the list, project repositories should adhere to these quality standards (http://goreportcard.com/report/**github_user**/**github_repo**):
|
||||||
|
|
||||||
- Code functions as documented and expected
|
- Code functions as documented and expected
|
||||||
- Generally useful to the wider community of Go programmers
|
- Generally useful to the wider community of Go programmers
|
||||||
@ -34,7 +35,7 @@ To be on the list, project repositories should adhere to these quality standards
|
|||||||
|
|
||||||
## Reporting issues
|
## 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 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.
|
Please open an issue if you would like to 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.
|
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.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user