We really appreciate all pull requests to this project, but we also have a few guidelines in place to help keep the project consistent and reduce the noise in commits, pull requests and code. Hopefully these guidelines are clear and easy to follow, if not then feel free to add an issue to address this.
Before starting any development please make an issue to communicate your intent and ensure that you are not duplicating work.
Please ensure that any contributions are formatted using the following guidelines:
- Empty line at the end of each plaintext file
- Use "LF" line endings
- Use 2 character spaces as much as possible
- Following the naming conventions of the files currently in the repository
- For images, webp is preferred although for larger images you can use JPEG.
- For source files, a line length of 120 is encouraged
- Following the same formatting as currently in use
-
Submit any pull request to the
mainbranch, unless you are really sure you need to push your changes elsewhere. -
Unless your pull request is trivial, expect comments and suggestions on your pull request. We will provide feedback as soon as possible.
-
We cannot accept or test any pull request with merge conflicts, so please fix these before submitting your pull request.
-
Please ensure pull requests are small and focussed. This means that they should only address a single feature, change or bug fix. Larger pull requests trying to fix multiple things at once should be split into smaller pull requests.
-
All tests must pass before a pull request is accepted.
-
If your pull request adds a new feature, please make sure that you add new test cases to cover this feature.
-
In your commit messages, the first line should be a short summary of the changes. Following this should be an empty line, then the remaining commit message explaining the changes in more detail.
-
Use the present tense to say what the commit changes.
-
Check for any unnecessary whitespace changes with
git diff --checkbefore committing your changes.