Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 3.58 KB
Raw

Contributing to this repository

We welcome your contributions! There are multiple ways to contribute, even if you're not a developer.

Opening issues

If you think you've found a security vulnerability, do not open a GitHub issue. Instead, follow the instructions in our security policy.

To report a bug or request an enhancement that is not related to a security vulnerabiliity, open a GitHub issue. When filing a bug, remember that the better written the bug is, the more easier and more likely it is to be reproduced and fixed.

Pre-requisites for code or documentation submissions

Before we can review or accept any source code or documentation-related contribution, you will need digitally sign the Oracle Contributor Agreement (OCA) using the OCA Signing Service. This only needs to be done once, so if you've signed it for another repository or project, there is no need to sign again.

All your commit messages must include the following line using the same name and email 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

We can only accept pull requests from contributors who have been verified as having signed the OCA.

Commit messages

This project uses Conventional Commits and is Commitizen friendly.

If you already have Commitizen installed, you can run git cz ... instead of git commit ... and Commitizen will make sure your commit message is in the right format and provides all the necessary information.

If you don't have Commitizen installed, a pre-commit git hook will analyze your commit message and report anything that needs to be fixed. For example:

$ git commit -m "Updated the contribution guide."
⧗   input: Updated the contribution guide.
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]
⚠   message must be signed off [signed-off-by]

✖   found 2 problems, 1 warnings
ⓘ   Get help: https://github.com/oracle-actions/.github/blob/main/CONTRIBUTING.md#commit-messages

husky - commit-msg hook exited with code 1 (error)

If you have any questions, please check the Conventional Commits FAQ, start a discussion or open an issue.

Pull request process

  1. Ensure there is an issue created to track and discuss the fix or enhancement you intend to submit.
  2. Fork this repository
  3. 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. Ensure that any documentation is updated with the changes that are required by your change.
  5. 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. We will assign the pull request to specific people for review before it is merged.

Code of conduct

Our Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.