CONTRIBUTING.md

Contributing to this Project

• Contributing to OpenSearch

  • First Things First
  • Ways to Contribute
    • Bug Reports
    • Feature Requests
    • Documentation Changes
    • Contributing Code
  • Developer Certificate of Origin
  • Submitting a pull request
  • Review Process

  Submitting a Pull Request

  Before submitting a pull request make sure you have validated the following:

  1. Check the Version and Branching section before commiting a change through PR.
  2. All the individual commits in the PR should be signed off. See DCO section for more details.
  3. For changes to a chart under charts/, add a changeset file to that chart's changeset/ directory rather than bumping the version or editing CHANGELOG.md. Copy changeset/example.md, rename it, and describe the change. Maintainers fold changesets into CHANGELOG.md and bump the version at release. Infra, CI, and docs changes need no changeset.
  4. Make sure the PR does not have any merge conflicts. If there are any conflicts please rebase your commits over the code in main branch.
  5. Ensure the linting and testing checks passes once you raise the PR. Unless the lint is passing the PR cannot be merged. You will be able to see the results of the workflows. In case it is failing you can use it to debug further.