Skip to content

docs: add contributing guidelines to the repository #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add contributing guidelines to the repository #545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to cortex-helm-chart

Thank you for your interest in contributing to the cortex-helm-chart project!

## How to Contribute

1. **Fork the repository** and create your branch from `master`.
2. **Make your changes** in the appropriate files (for example, `README.md.gotmpl` or `values.yaml`).
3. **Update the generated README.md**:

The `README.md` file is generated automatically. After making changes to `README.md.gotmpl` or `values.yaml`, run the following command to update `README.md`:

```sh
make README.md
```

This command uses [helm-docs](https://github.com/norwoodj/helm-docs) in a Docker container to regenerate the documentation.

4. **Commit your changes**, including the updated `README.md`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify the commit must be signed like with -s

5. **Push your branch** and open a Pull Request with a clear description of your changes.

## Guidelines

- Please discuss any major changes via issue before submitting a pull request.
- Ensure your code and documentation changes are clear and concise.
- Follow the existing style and conventions of the repository.

Thank you for helping improve cortex-helm-chart!