How to contribute

Getting Started

Pick a feature from the TODO Features or Issues. You could also implement your own module/functions.
If you picked a feature from list, please create an issue for it (so other contributors don't implement the same feature).
Fork the repository 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
Format cmake files with cmake-format CMakeLists.txt cmake/*.cmake -i
Push your changes to the branch in your fork of the repository.
Submit a pull request to the repository.

Additional Resources

If you have any questions about features you can join Discord Channel.
Features implementations in Faker.js could be helpful as a reference.