Thanks much for contributing - To contribute to this project, please follow the recommendations and requirements below. This helps to address your contribution in a timely manner. Contributing is done through submitting pull requests.
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
- Ensure the bug/feature was not already reported by searching on GitHub under Issues. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress).
- Fork this repo.
- Clone the forked repo to your machine.
- Commit changes to your own branch.
- Push your work back up to your fork.
- Submit a Pull Request against the
master
branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small.
NOTE: Make sure to sync your fork before making a pull request.
- Use clean, simple, well styled code.
- Use comments.
- Minimize number of dependencies.
- Make sure that your code builds, lints and passes the unit tests.
- Increase code coverage, not versa.
- To reduce merge conflicts, rebase your branch before submitting your pull request.
- Reference the issue number in the comments of your pull request.
- Monitor your pull requests. Please respond in a timely manner to any comments, questions for changes requested. Abandoned pull requests may be closed.
Follow the Salesforce Open Source Community Code of Conduct.
By contributing code, you agree to license your contribution under the terms of the BSD 3-Clause.
All external contributors must sign our Contributor License Agreement (CLA).