Thanks for showing an interest in improving LeanHRPT, these guidelines outline how you should go about contributing to the project.
- Make sure the bug has not already been reported.
- If an issue already exists, leave a thumbs up to "bump" the issue
- If an issue doesn't exist, open a new one with a clear title and description and, if relevant, any files that cause the behaviour
- Fork this repository and put your changes on a new branch.
- Make sure to use sensible commit names (no "Oops" commits)
- Open a new pull request into master.
If you don't have a GitHub account, you can email me the patch at xerbo (at) protonmail (dot) com
The coding style of LeanHRPT is based off the Google C++ Style Guide with minor modifications (see .clang-format), in addition to this all files should use LF line endings and end in a newline. Use American english (i.e. color, not colour).
To automate this LeanHRPT comes with pre-commit hooks which will enforce these rules.
LeanHRPT is developed with VSCode with the following extensions, while not required they may make your life easier:
- Keep titles short to prevent wrapping (descriptions exist)
- Split up large changes into multiple commits
- Never use hastags for sequential counting in commits, as this interferes with issue/PR referencing