We welcome your contributions! There are multiple ways to contribute, including filing issues with feedback, bugs and suggestions, as well as contributing code. See these guidelines for suggestions of things to do and our Style Guide for notes on coding conventions, style, warnings and errors.
For bugs or suggestions, please file a GitHub issue unless it's security related. When filing a bug, remember that the better written the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions on our Security Policy.
You will need to sign the Oracle Contributor Agreement (OCA).
For pull requests to be accepted, the bottom of your commit message must have the following line using the name and e-mail address you used for the OCA.
Signed-off-by: Your Name <[email protected]>
This can be automatically added to pull requests by committing with:
git commit --signoff
Only pull requests from committers who can be verified as having signed the OCA can be accepted.
- Fork this repository
- Create a branch in your fork to implement your changes. We recommend creating an issue
to describe the problem you are addressing, if one does not already exist, and using
the issue number as part of your branch name, e.g.
1234-fixes - Ensure that any documentation is updated with the changes that are required by your fix.
- Ensure that your changes have not broken any existing proofs (
./Scripts/run-everything.sh yesshould complete without errors). - Update the list of contributors to include your name if it does not already.
- Submit a pull request. Do not leave the pull request blank. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes. Ensure that you reference the issue you created as well.
- We will review the pull request before it is merged.
Follow the Golden Rule. If you'd like more specific guidelines see the Contributor Covenant Code of Conduct.