Skip to main content
We welcome your contributions! There are multiple ways to contribute to this project.

​
Opening Issues

For bugs or enhancement requests, 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 in our security policy.

​
Contributing Code

We welcome your code contributions. Before submitting code via a pull request, you will need to have signed the Oracle Contributor Agreement (OCA) and your commits need to include the following line using the name and e-mail address you used to sign the OCA: 
Signed-off-by: Your Name <[email protected]>
This can be automatically added to pull requests by committing with --sign-off or -s, e.g. 
git commit --signoff
Only pull requests from committers that can be verified as having signed the OCA can be accepted.

​
Pull Request Process

  1. Create an issue: Ensure there is an issue created to track and discuss the fix or enhancement you intend to submit.
  2. Fork the repository: Fork this repository to your own GitHub account.
  3. Create a branch: Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, e.g. 1234-fixes.
  4. Update documentation: Ensure that any documentation is updated with the changes that are required by your change.
  5. Update samples: Ensure that any samples are updated if the base image has been changed.
  6. Submit the 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.
  7. Review process: We will assign the pull request to 2-3 people for review before it is merged.

​
Code of Conduct

Follow the Golden Rule. If you’d like more specific guidelines, see the Contributor Covenant Code of Conduct.

​
Oracle Contributor Agreement

All contributors must sign the Oracle Contributor Agreement (OCA) before their contributions can be accepted. This agreement allows Oracle to distribute your contributions under the project’s license. The OCA:
  • Protects you as a contributor
  • Protects Oracle and users of the project
  • Does not change your rights to use your own contributions for any other purpose
Make sure to use the same name and email address in your git commits as you used when signing the OCA.

Build docs developers (and LLMs) love

Get started for freeTalk to us