Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-26 04:17:33 +00:00
Code Issues Releases Activity

Add more contributing notes.

Browse Source
This commit is contained in:
Brenden Matthews 2019-03-03 13:18:46 -05:00
parent 7ee8a0d6ef
commit 18d1a06dd3
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -5,6 +5,8 @@ Contributions are welcome from anyone.
To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new). 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). To submit code changes, open [new pull requests](https://github.com/brndnmtthws/conky/compare).
## Guidelines
Patches submitted in issues, email, or elsewhere may be ignored. When submitting PRs, please: Patches submitted in issues, email, or elsewhere may be ignored. When submitting PRs, please:
- Describe the changes, why they were necessary, etc - Describe the changes, why they were necessary, etc
@ -18,3 +20,15 @@ Patches submitted in issues, email, or elsewhere may be ignored. When submitting
- PRs with failed checks may be ignored or closed; please make sure - 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 the build and checks pass if possible (and notify someone when the build
system is not working) system is not working)
## Coding Style
Code should be formatted using `clang-format`. By configuring Conky with `cmake -DCHECK_CODE_QUALITY=ON`, you will be able to run `make clang-format` to automatically format code.
If code in your PR is not formatted according to [`.clang-format`](.clang-format), the checks will not pass.
## Unit Testing
Unit tests are a relatively new addition to Conky, and most existing code does not have tests. Conky uses the [Catch2](https://github.com/catchorg/Catch2) unit testing framework.
If you are adding new functions or methods, please consider adding unit tests for that code. Additionally, if you'd like to add tests for existing code, that would be a welcome contribution.