diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fd8ba8bd..474c2e07 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96aecf58..83ab6c54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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?