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

Clarifying documentation requirements now that GoReportCard no longer checks for documentation formatting. (#4173)

Browse Source
This commit is contained in:
Shannon 2022-04-11 15:53:26 -07:00 committed by Avelino
parent c8b3566bb3
commit 2e0f9bb9ec
No known key found for this signature in database
GPG Key ID: B345B4D52E98180A
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -23,10 +23,10 @@ To be on the list, project repositories should adhere to the following quality s
- function as documented and expected; - function as documented and expected;
- be generally useful to the wider community of Go programmers; - be generally useful to the wider community of Go programmers;
- be actively maintained with: - be actively maintained with:
- Regular, recent commits; - regular, recent commits;
- Or, for finished projects, issues and pull requests are responded to generally within 2 weeks; - or, for finished projects, issues and pull requests are responded to generally within 2 weeks;
- be stable or progressing toward stable; - be stable or progressing toward stable;
- be thoroughly documented (README, pkg.go.dev doc comments, etc.) in the english language, so everyone is able to understand the project's intention and how it works; - be thoroughly documented (README, pkg.go.dev doc comments, etc.) in the english language, so everyone is able to understand the project's intention and how it works. All public functions and types should have a Go style documentation header;
- if the library/program is testable, then coverage should be >= 80% for non-data-related packages and >=90% for data related packages. (**Note**: the tests will be reviewed too. We will check your coverage manually if your package's coverage is just a benchmark results); - if the library/program is testable, then coverage should be >= 80% for non-data-related packages and >=90% for data related packages. (**Note**: the tests will be reviewed too. We will check your coverage manually if your package's coverage is just a benchmark results);
- have at least one official version-numbered release that allows go.mod files to list the file by version number, of the form vX.X.X. - have at least one official version-numbered release that allows go.mod files to list the file by version number, of the form vX.X.X.