RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 03:27:45 +00:00
Code Issues Activity Actions

Meta: Add some more notes to the contribution guidelines

Browse source
This commit is contained in:
Andreas Kling 2019-08-17 21:45:06 +02:00
parent 272bd1d3ef
commit a20f3c6647
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Contributing.md
View file

@ -14,12 +14,14 @@ Nobody is perfect, and sometimes we mess things up. That said, here are some goo
**Do:** **Do:**
* Write in idiomatic Serenity C++17, using the `AK` containers in all code.
* Conform to the project coding style. Please use `clang-format` (version 8 or newer) to automatically format C++ files. * Conform to the project coding style. Please use `clang-format` (version 8 or newer) to automatically format C++ files.
* Choose expressive variable, function and class names. Make it as obvious as possible what the code is doing. * Choose expressive variable, function and class names. Make it as obvious as possible what the code is doing.
* Split your changes into separate, atomic commits. * Split your changes into separate, atomic commits.
* Make sure your commits are rebased on the master branch. * Make sure your commits are rebased on the master branch.
* Wrap your commit messages at 72 characters. * Wrap your commit messages at 72 characters.
* Write your commit messages in proper English, with care and punctuation. * Write your commit messages in proper English, with care and punctuation.
* Squash your commits when making revisions after a patch review.
**Don't:** **Don't:**
@ -28,6 +30,7 @@ Nobody is perfect, and sometimes we mess things up. That said, here are some goo
* Iterate excessively on your design across multiple commits. * Iterate excessively on your design across multiple commits.
* Use weasel-words like "refactor" or "fix" to avoid explaining what's being changed. * Use weasel-words like "refactor" or "fix" to avoid explaining what's being changed.
* Include commented-out code. * Include commented-out code.
* Write in C.
## Code of Conduct (lol) ## Code of Conduct (lol)