Skip to content

Latest commit

 

History

History
98 lines (61 loc) · 2.39 KB

CONTRIBUTING.rst

File metadata and controls

98 lines (61 loc) · 2.39 KB
Raw

Contributing

We welcome contributions to any of the charts! This document outlines the process for contributing to this project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally:
git clone https://github.com/codewithemad/helm-charts.git
cd helm-charts
  1. Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name

Making Changes

  1. Make your changes in your feature branch.
  2. Update or add tests as necessary.
  3. Update documentation, including README.rst and CHANGELOG.rst, if applicable.
  4. Ensure your code follows the project's style and best practices.

Testing Your Changes

Before submitting a pull request, make sure to test your changes:

  1. Run the Helm linter:
helm lint charts/<chart-dir>
  1. Perform a template rendering:
helm template charts/<chart-dir>
  1. Do a dry-run installation:
helm install --dry-run --debug test charts/<chart-dir>

Submitting a Pull Request

  1. Push your changes to your fork on GitHub:
git push origin feature/your-feature-name
  1. Go to the original repository on GitHub and create a new Pull Request.
  2. Provide a clear description of the changes and reference any related issues.
  3. Submit the Pull Request for review.

After Submitting

  • Respond to any feedback on your Pull Request.
  • If requested, make additional commits to your branch and push them.
  • Once approved, your Pull Request will be merged into the main branch.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check if the issue already exists in the GitHub issue tracker.
  2. If not, create a new issue, providing as much relevant information as possible.

Style Guide

  • Follow the Helm best practices for chart development.
  • Use clear, descriptive commit messages.
  • Maintain consistent indentation and formatting.

Questions?

If you have any questions about contributing, feel free to ask in the issue tracker.

Thank you for contributing!