From 7ee8a0d6ef77329e1865e8f97bcd79f3ccee47d3 Mon Sep 17 00:00:00 2001 From: Brenden Matthews Date: Sun, 3 Mar 2019 11:33:11 -0500 Subject: [PATCH] Move contributing section to `CONTRIBUTING.md`. --- CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 17 +---------------- 2 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a2d18606 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +Contributions are welcome from anyone. + +To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new). +To submit code changes, open [new pull requests](https://github.com/brndnmtthws/conky/compare). + +Patches submitted in issues, email, or elsewhere may be ignored. When submitting PRs, please: + +- Describe the changes, why they were necessary, etc +- Describe how the changes affect existing behaviour +- Describe how you tested and validated your changes +- Include unit tests when appropriate +- Include any relevant screenshots/evidence demonstrating that the changes work and have been tested +- Any new source files should include a GPLv3 license header +- Any contributed code must be GPLv3 licensed +- Always leave the code better than you found it +- PRs with failed checks may be ignored or closed; please make sure + the build and checks pass if possible (and notify someone when the build + system is not working) diff --git a/README.md b/README.md index dc831785..a5429170 100644 --- a/README.md +++ b/README.md @@ -56,22 +56,7 @@ Conky is licensed under the terms of the [GPLv3](LICENSE) license. Contributions are welcome from anyone. -To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new). -To submit code changes, open [new pull requests](https://github.com/brndnmtthws/conky/compare). - -Patches submitted in issues, email, or elsewhere may be ignored. When submitting PRs, please: - -- Describe the changes, why they were necessary, etc -- Describe how the changes affect existing behaviour -- Describe how you tested and validated your changes -- Include unit tests when appropriate -- Include any relevant screenshots/evidence demonstrating that the changes work and have been tested -- Any new source files should include a GPLv3 license header -- Any contributed code must be GPLv3 licensed -- Always leave the code better than you found it -- PRs with failed checks may be ignored or closed; please make sure - the build and checks pass if possible (and notify someone when the build - system is not working) +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to Conky. [mpd]: https://musicpd.org/ [xmms2]: https://github.com/xmms2/wiki/wiki