As all Open Source software, contributions to Sugarizer are welcome.
A good way to start to contribute is testing and trying Sugarizer to find some issues. If you find one, don't be shy, submit your issue here by giving the maximum information on it, specifically detailed steps to reproduce it. We will check your issue and ask you more information if needed.
Issues are also the way to propose new features. If you have a suggestion, explain it in detail in an issue and we will discuss it.
If you're a developer, the best way to start is to read the architecture then to do the whole tutorial. It will give you a good understanding of Sugarizer internal.
When you think you're ready, you could try to fix some existing issues here. If you find a fix, send a Pull Request, we will be pleased to review it.
Note that the master branch of the repository is for released/stable version, the dev branch is for development.
So to send your Pull Request:
- Clone this repository,
- Fork the dev branch of your new repository,
- Update this new branch with your contribution and commit your changes,
- Send a pull request from your new branch to the dev branch of this repository.
Few rules to respect when you fix an issue:
- Do not send a Pull Request without a related issue that has been approved by a Sugarizer maintainer,
- Ensure your pull request contains only update related to the fix,
- Respect indentation of the original file,
- Mention the issue number in the pull request but not in the commit message
Please note there is no need to ask permission to work on an issue. You should check for pull requests linked to an issue you are addressing; if there are none, then assume nobody has done anything. Begin to fix the problem, test, make your commits, push your commits, then make a pull request. These practices allow the competition of ideas and give priority to meritocracy.
Thanks in advance for your contribution and to become a member of Sugarizer community!