Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 913 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 913 Bytes

Contribution Guidelines

Issues

Found a bug? Got a question? Want some enhancement?
First place to go is the repository issues section, and I'll try to help as much as possible.

Pull Requests

Fixed a bug or just want to provided additional functionality?
Simply fork this repository, implement your changes and create a pull request.
Few guidelines regarding pull requests:

  • This repository is integrated with github actions for continuous integration.

Your pull request build must pass (the build will run automatically).
You can run the following command locally to ensure the build will pass:

mkdir ./target
cd ./target
cmake ..
make
ctest -C Release --output-on-failure
  • There are many automatic unit tests as part of the library which provide full coverage of the functionality.
    Any fix/enhancement must come with a set of tests to ensure it's working well.