From 94d76c321cdaf0162eb47ac626db1fedd7b27614 Mon Sep 17 00:00:00 2001 From: Shannon Date: Mon, 11 Apr 2022 15:53:26 -0700 Subject: [PATCH] Clarifying documentation requirements now that GoReportCard no longer checks for documentation formatting. (#4173) --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1225013e..2c325478 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,10 +23,10 @@ To be on the list, project repositories should adhere to the following quality s - function as documented and expected; - be generally useful to the wider community of Go programmers; - be actively maintained with: - - Regular, recent commits; - - Or, for finished projects, issues and pull requests are responded to generally within 2 weeks; + - regular, recent commits; + - or, for finished projects, issues and pull requests are responded to generally within 2 weeks; - 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); - 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.