Commit ced1b61fd3afa50964af428a185bb218d2770179
Committed by
Moritz Wirger
Moritz Wirger
1 parent
57ccbed1
Preliminary contribution guide.
Showing
1 changed file
with
19 additions
and
0 deletions
.github/CONTRIBUTING.md
0 → 100644
| 1 | +# Contribution Guide | ||
| 2 | +Help is always welcome. If you want to contribute to hueplusplus, please read these guidelines | ||
| 3 | + | ||
| 4 | +## Request feature / Report bug | ||
| 5 | +To request a feature or report a bug, create an issue using the templates. | ||
| 6 | + | ||
| 7 | +## Making changes | ||
| 8 | +If you want to add a new feature or fix a bug, first check out the development branch. | ||
| 9 | +Maybe the feature already exists and you would just do duplicate work. | ||
| 10 | + | ||
| 11 | +Also use the development branch as the base for your feature branch, because all pull requests are first rebased into development. | ||
| 12 | + | ||
| 13 | +## Pull requests | ||
| 14 | +When creating a pull request, be sure to choose development as the target. | ||
| 15 | +You might need to rebase on development again and merge in new changes. | ||
| 16 | + | ||
| 17 | +## Code style | ||
| 18 | +The code is formatted using clang-format. If you do not want to use it yourself, try to keep your style consistent with the other code | ||
| 19 | +so not too many reformats are necessary. |