CONTRIBUTING.md

How to contribute

Getting Started

• Pick an issue from Issues.
• Fork the repository on GitHub
• Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Making Changes

• Create a feature/bug branch from main branch:

  git checkout -b feature/feature-name

  Please avoid working directly on the main branch.

• Make commits of logical units.

• Make sure you have added the necessary tests for your changes.

• Run all the tests to assure nothing else was accidentally broken.

• If you've added a new file to your project with non-Latin characters, ensure that the file encoding is set to Unicode (UTF-8 without signature) - Codepage 65001 in Microsoft Visual Studio Code.

Submitting Changes

• Format code with clang-format src/**/*.cpp src/**/*.h include/**/*.h -i -style=file
• Push your changes to the branch in your fork of the repository.
• Submit a pull request to the repository.