A helpful bug report is the most valuable contribution this project can receive. Thank you! To ensure that your bug report is in fact helpful be sure to do your due diligence by troubleshooting. Check the issues to ensure your bug hasn't already been submitted. When you do submit, be specific about your version, your environment, compiler, etc. Include all the steps required to reproduce the buggy behavior.
Before creating a PR, consider opening an issue to discuss the problem and solution. Lob is a solo-authored project with a specific technical direction, PRs that don't fit that direction are unlikely to be accepted. But if you do create a PR, be sure to include a description of the problem and solution. Always include tests if applicable.
- Keep commits small and focused
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move error check to..." not "Moves error check to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
Follow the style you see! This project uses a format and style from the Google style guide for C++. The style and formatting is enforced by CI. Consult the HACKING.md document for details on how to run the style checks locally as cmake targets.
Please see the CODE_OF_CONDUCT.md document.
Helpful notes for developers can be found in the HACKING.md document.
In addition to the above, if you use the presets file as instructed, then you should NOT check it into source control, just as the CMake documentation suggests.