Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 2.44 KB
Raw

Contributing

We welcome your contributions! There are multiple ways to contribute.

Discussions

Join us at #helidon-users and participate in discussions.

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. 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. Make sure to base your branch off of the corresponding dev-N.x branch (where N is the major Helidon version).
  4. 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. Target your PR to the corresponding dev-N.x branch.
  5. We will assign the pull request for review and running of PR validation workflow before it is merged.

Development work for examples is performed in the dev-N.x branches (where N corresponds to a Helidon major version). For example, to make a change to a Helidon 4 example you would use the dev-4.x branch.

Code of Conduct

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