How to contribute to the project

Even though this project is commercial, you may want to contribute to it. This page explains how to do that.

Reporting issues

If you find a bug or have a feature request, please open an issue on GitHub.

How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn't exist in the project, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that the project has today have been added because our users saw the need. Open an issue on GitHub which describes the feature you would like to see, why you need it, and how it should work.

How to contribute to the project

If you want to contribute to the project, you can do so by making a pull request. Here are the steps to do that:

  1. Create a personal fork of the project on Github.
  2. Clone the fork on your local machine. Your remote repo on Github is called origin.
  3. Add the original repository as a remote called upstream.
  4. If you created your fork a while ago be sure to pull upstream changes into your local repository.
  5. Create a new branch to work on! Branch from develop if it exists, else from main.
  6. Implement/fix your feature, comment your code.
  7. Follow the code style of the project, including indentation.
  8. If the project has tests run them!
  9. Write or adapt tests as needed.
  10. Add or change the documentation as needed.
  11. Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
  12. Push your branch to your fork on Github, the remote origin.
  13. From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for main!
  14. If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.
  15. Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).
  16. And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
Last updated 7 months ago
Scroll to top
Was this article helpful?