Skip to content

Commit

Permalink
Add contributing guidelines for Helm Charts (#195)
Browse files Browse the repository at this point in the history
Signed-off-by: TheAlgo <[email protected]>
  • Loading branch information
TheAlgo authored Jan 19, 2022
1 parent 63847ee commit 8c4e35e
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
## Contributing to this Project

OpenSearch is a community project that is built and maintained by people just like **you**.
[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.
- [Contributing to OpenSearch](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#contributing-to-opensearch)
- [First Things First](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#contributing-to-opensearch)
- [Ways to Contribute](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#ways-to-contribute)
- [Bug Reports](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#bug-reports)
- [Feature Requests](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#feature-requests)
- [Documentation Changes](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#documentation-changes)
- [Contributing Code](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#contributing-code)
- [Developer Certificate of Origin](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin)
- [Submitting a pull request](#submitting-a-pull-request)
- [Review Process](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#review-process)

## Submitting a Pull Request

Before submitting a pull request make sure you have validated the following:
1. All the individual commits in the PR should be signed off. See DCO [section](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin) for more details.
1. Chart version should be bumped for every code change except docoumentation change. Refer the PR [#179](https://github.com/opensearch-project/helm-charts/pull/179) for an example.
1. 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.
1. 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.

0 comments on commit 8c4e35e

Please sign in to comment.