summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Debertol <michael.debertol@gmail.com>2021-07-16 19:54:41 +0200
committerGitHub <noreply@github.com>2021-07-16 19:54:41 +0200
commit2d74d052fc4d1af79bbdcadcb1979b436cbd0369 (patch)
treeb2f5d09d4fe8f2c119e5a59873ea6b1fad28f873
parentf5ba8b181133392b4073daa9e936535b10edb7ff (diff)
Mention the GNU manual in the contributing guide
-rw-r--r--CONTRIBUTING.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1cb9b333a..c9a50cd1e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,7 +17,7 @@ search the issues to make sure no one else is working on it.
## Best practices
-1. Follow what GNU is doing in term of options and behavior.
+1. Follow what GNU is doing in terms of options and behavior. It is recommended to look at the GNU Coreutils manual ([on the web](https://www.gnu.org/software/coreutils/manual/html_node/index.html), or locally using `info <utility>`). It is more in depth than the man pages and provides a good description of available features and their implementation details.
1. If possible, look at the GNU test suite execution in the CI and make the test work if failing.
1. Use clap for argument management.
1. Make sure that the code coverage is covering all of the cases, including errors.