mirror of
https://github.com/Llewellynvdm/conky.git
synced 2025-02-04 21:18:33 +00:00
Move contributing section to CONTRIBUTING.md
.
This commit is contained in:
parent
1d409379ab
commit
7ee8a0d6ef
20
CONTRIBUTING.md
Normal file
20
CONTRIBUTING.md
Normal file
@ -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)
|
17
README.md
17
README.md
@ -56,22 +56,7 @@ Conky is licensed under the terms of the [GPLv3](LICENSE) license.
|
|||||||
|
|
||||||
Contributions are welcome from anyone.
|
Contributions are welcome from anyone.
|
||||||
|
|
||||||
To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new).
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to Conky.
|
||||||
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)
|
|
||||||
|
|
||||||
[mpd]: https://musicpd.org/
|
[mpd]: https://musicpd.org/
|
||||||
[xmms2]: https://github.com/xmms2/wiki/wiki
|
[xmms2]: https://github.com/xmms2/wiki/wiki
|
||||||
|
Loading…
x
Reference in New Issue
Block a user