Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

97 lines (64 loc) · 2.7 KB

Contributing to Vector Helm Charts

Thank you for your interest in contributing to the Vector Helm Charts repository. This document provides guidelines and instructions for contributing to this project.

Getting Started

Prerequisites

Before contributing, ensure you have the following tools installed:

Development Workflow

1. Fork and Clone

  1. Fork the repository on GitHub

  2. Clone your fork locally:

    git clone https://github.com/YOUR_USERNAME/helm-charts.git
cd helm-charts

  3. Add the upstream repository:

    git remote add upstream https://github.com/vectordotdev/helm-charts.git

2. Create a Feature Branch

Always create a new branch for your changes:

git checkout -b feature/your-feature-name

Use descriptive branch names that indicate the purpose of your changes.

3. Making Changes

Chart Development

  • Make changes to the relevant chart in the charts/ directory
  • Update documentation in README.md.gotmpl (not README.md directly) and then run helm-docs
  • Test your changes thoroughly

4. Submit Pull Request

  1. Push your branch to your fork:

    git push origin feature/your-feature-name

  2. Create a pull request against the develop branch (not master)

  3. Fill out the PR template with:

    • Clear description of changes
    • Testing steps
    • Related issues (if any)

  4. Make sure the PR title follows the Conventional Commits format:

<type>(scope): <description>

Examples:

  • feat(vector): add support for custom annotations
  • fix(vector): correct RBAC permissions for metrics
  • docs(vector): update configuration examples
  • chore(deps): update helm-docs version

All allowed scopes and types can be found here

Pull Request Guidelines

Review Process

  1. Maintainers will review your PR
  2. Address any feedback or requested changes
  3. Once approved, maintainers will merge your PR
  4. Your changes will be included in the next release, which should be in the same day or before the Vector release. See the Vector public calendar

Issue Reporting

Before Reporting

  • Search existing issues to avoid duplicates
  • Test with the latest chart version
  • Gather relevant information (Kubernetes version, Helm version, chart values)