Sucrose is the core charting library for the Sugar application, so please discuss any major new feature changes or enhancements to this project with the project's maintainers first. We may not be able to accommodate certain changes. Please feel free to contact the maintainers if you have questions. Bug fixes and performance improvements are always welcome.
To contribute,
- Fork this repository.
- Search for any open issues on the Sucrose Github Issues site related to the improvement you are interested in making. Team up with other developers if you see a related issues.
- Create a new issue to track progress, commits and general discussions on a proprosed change (limit discussion in PRs to code related topics).
- Work on your changes within a topic branch on your fork of Sucrose.
- Create a pull request from your topic branch to the Sucrose master branch with reference to the issue you created.
- The maintainers may choose to merge your changes directly, or may create a test build with your changes for internal testing by SugarCRM's QA team.
Pull requests are accepted under the discretion of the Sucrose maintainer(s). Improve the chances your PR will be merged by following the requirements and guidelines below. For any questions, please e-mail [email protected].
REQUIREMENTS
- By creating a pull request, you are agreeing to SugarCRM Open Source Contributor terms.
GUIDELINES
- Make sure your pull contains quality code. We will certainly provide constructive feedback on works in progress but we will not merge incomplete pull requests.
- Check your code with jsHint or whatever code quality tool of your choosing.
- Attempt to follow existing code conventions found in the library.
- Make sure your pull is fully documented.
- Reference related Github Issues within commit comments and pull request comment where appropriate.
- Squash out minor or "typo" commits in your pull using
git commit -aorgit rebase -i.
BUGS
File bugs or feature requests using Github Issue Tracker.