Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

57 lines (45 loc) · 3.11 KB
Raw

How to contribute

An evolving contribution guide...

Before contributing, please have a look at the Code of Conduct. By contributing, you are expected to uphold this code.

Contact

Reporting bugs

  • The easiest way to report a bug is to simply file an issue here on GitHub.
  • Before doing so, please ensure the bug was not already reported by searching on GitHub under Issues.
  • Be sure to include a title and clear description in the issue.
  • Provide as much relevant information as possible. In particular, state what the expected behavior should be, and add some sample code or a full test case that demonstrate that the expected behavior is not occurring.

Pull requests

  • Thank you for contributing! Read more about pull requests here.
  • Before starting work on larger non-bugfix pull requests, i.e. pull requests that would add new features, please contact the project lead first (see above) to align with the project goals, and to make sure the feature is not already being worked on.
    • This will greatly increase the chances of your pull request being accepted!
  • In a pull request, please provide a clear list of what you have done. Always write a clear log message for your commits. Include the relevant issue number, if applicable.
  • Each pull request should have one clear function (i.e. adding a specific feature or fixing a particular bug). Tests are part of this function and should always be provided. However, separate concerns and keep pull requests at fine granularity. Try not to submit several feature additions and/or bug fixes in one pull request.

Feature requests

  • See also here for information on status and roadmap.
  • Please get in touch with the project lead (see above) to discuss feasibility and planning.
  • The best feature request is eventually provided in the form of a pull request; please see above.

Coding conventions

  • Please try to adhere to the existing formatting conventions for reasons of consistency.
  • The easiest way to adhere to the formatting conventions is to reformat your code using clang-format before committing. A respective .clang-format file is provided in the repository, and (in absence of explicit guidelines) serves as implicit documentation for the formatting conventions.
  • General coding guidelines and conventions that this project follows are given here.
  • All code should be written in conforming, platform-independent C++17.
  • The project should always compile using GCC (version 8+), Clang (version 7+), and the Visual C++ compiler (recent version of Visual Studio 2017+). (This will be checked during continuous integration.)