Thank you for considering contributing to erxes! This document will outline how to submit changes to this repository and which conventions to follow. If you are ever in doubt about anything, we encourage you to reach out by submitting an issue here or via Discord.
All changes should be part of a branch and submitted as a pull request - your branches should be prefixed with one of:
Strive towards keeping your commits small and isolated - this helps the reviewer understand what is going on and makes it easier to process your requests.
Once your changes are ready, you must submit your branch as a pull request. Your pull request should be opened against the development branch in the main erxes repo.
In your PR's description, you should follow the structure:
We highly encourage that you do a self-review prior to requesting a review. To do a self-review click the review button in the top right corner, go through your code and annotate your changes. This makes it easier for the reviewer to process your PR.
All pull requests are squashed and merged.
All PRs should include tests for the changes that are included. We have two types of tests that must be written:
Afterwards, if you're contributing to our documentation about changes you made to erxes codebase make sure to also check out the contribution guidelines on our documentation website.
The erxes team will regularly create releases from the develop branch.
Contribute to open source
Previous Page
Getting started with plugin
Learn how to create an erxes plugin from scratch