system/coreutils
system/coreutils
1
0
Fork 0
mirror of https://github.com/uutils/coreutils synced 2024-10-02 22:13:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update of "contributing" documentation

Browse source
This commit is contained in:
Sylvestre Ledru 2020-12-14 12:45:36 +01:00 committed by GitHub
parent 15e58a72c8
commit ef25a6874e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -5,16 +5,24 @@ standard libraries are stabilized. You may *claim* an item on the to-do list by
following these steps:
1. Open an issue named "Implement [the utility of your choice]", e.g. "Implement ls"
2. State that you are working on this utility.
3. Develop the utility.
4. Add integration tests.
5. Add the reference to your utility into Cargo.toml and Makefile.
6. Remove utility from the to-do list in the README.
7. Submit a pull request and close the issue.
1. State that you are working on this utility.
1. Develop the utility
1. Add integration tests.
1. Add the reference to your utility into Cargo.toml and Makefile.
1. Remove utility from the to-do list in the README.
1. Submit a pull request and close the issue.
The steps above imply that, before starting to work on a utility, you should
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. Use clap for argument management.
1. Make sure that the code coverage is covering all of the cases, including errors.
1. The code must be clippy-warning-free and rustfmt-compliant.
1. Don't hesitate to move common functions into uucore if they can be reused by other binaries.
## Commit messages
To help the project maintainers review pull requests from contributors across