Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.96 KB
Raw

Contributing to Project Helidon

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

Discussion

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

Opening Issues

If you hit a bug or have an enhancement request then file a GitHub issue. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. Please include:

  1. Version of Helidon
  2. Whether you are writing a Helidon SE or MP application
  3. OS
  4. Version of Docker or Kubernetes or other software if it's relevant to your issue
  5. Steps to reproduce

Contributing Code

We welcome code contributions, but we need the contributor to sign the Oracle Contributor Agreement (OCA) first.

Pull Request Process

  1. Sign the OCA
  2. Ensure there is an issue created to track and discuss the fix or enhancement you intend to submit.
  3. Fork this repository.
  4. 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. Follow DEV-GUIDELINES for a list of rules and best practices followed by project Helidon.
  5. Ensure that any documentation is updated with the changes that are required by your change.
  6. Ensure that any samples are updated if the base image has been changed.
  7. 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.
  8. 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