From be6e835f7976344604a006ff0eec1b55613f4b84 Mon Sep 17 00:00:00 2001 From: Joseph Crail Date: Thu, 3 Dec 2015 00:16:04 -0500 Subject: [PATCH] Move contributing section into separate file. GitHub uses CONTRIBUTING.md as the basis for a message to someone creating a new issue. I made a few changes to modernize the contribution section, but there's still room for updates. --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 13 +------------ 2 files changed, 17 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..3b9e1597a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +Contributing to coreutils +========================= + +Contributions are very welcome, and should target Rust's master branch until +Rust 1.0 is released. 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. + +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. diff --git a/README.md b/README.md index c70fa0569..71b110aa1 100644 --- a/README.md +++ b/README.md @@ -113,18 +113,7 @@ make TEST='UTILITY_1 UTILITY_2' test Contribute ---------- -Contributions are very welcome, and should target Rust's master branch until -Rust 1.0 is released. 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 the reference to your utility into uutils/uutils.rs (required for multibinary). -5. Remove utility from the to-do list on this README. -6. 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. +To contribute to coreutils, please see [CONTRIBUTING](CONTRIBUTING.md). To do -----