awesome/awesome-go
1
0
Fork 0
mirror of https://github.com/avelino/awesome-go.git synced 2024-11-07 16:33:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace godoc.org with pkg.go.dev in contributing guideline

Browse Source
This commit is contained in:
Andy Pan 2020-03-14 11:57:09 +08:00
parent 3cfd8f76f3
commit cff02f9ea2
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -3,9 +3,9 @@ Please check if what you want to add to `awesome-go` list meets [quality standar
**Please provide package links to:**
- github.com repo:
- godoc.org:
- pkg.go.dev:
- goreportcard.com:
- coverage service link ([gocover](http://gocover.io/), [coveralls](https://coveralls.io/) etc.)
- coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), [gocover](http://gocover.io/) etc.)
Very good coverage
@ -16,7 +16,7 @@ Very good coverage
- [ ] 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 godoc link to the repo and to my pull request.
- [ ] 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/master/CONTRIBUTING.md#contribution-guidelines), [maintainers note](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#maintainers) and [Quality standard](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standard).

2
CONTRIBUTING.md
View File

@ -31,7 +31,7 @@ To be on the list, project repositories should adhere to these quality standards
- 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.) in english language, so everyone is able to understand the project's intention and how it works
- Thoroughly documented (README, pkg.go.dev doc comments, etc.) in english language, so everyone is able to understand the project's intention and how it works
- 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.
## Congrats, your project got accepted - what now?