How to contribute

Start with an issue

Github Issues are used to design and discuss a potential feature, or a fix. When starting working on a development, make sure to have a corresponding open issue. You can pick an existing issue to start working on it or you can create an issue corresponding to your needs.

Fork the repository

We ask contributors to fork the repository and work from their fork.

Create a new branch

Create a new branch out of the latest main branch. Name the branch such that it's relevant to the issue you are working on.

Implement your solution

If you need to write code to implement your solution please do so with writing tests in a TDD fashion, keeping in mind the SOLID principles, and by applying our style guide.

Open a Pull Request

Open a pull request for your branch into the main branch and assign a reviewer for your code to be reviewed. If relevant, please provide a database name to be used to see the effects of your branch. Once your Pull Request has been reviewed and approved, you can merge it. Congratulations!