CONTRIBUTING.md

Welcome to charts contributing guide

Thank you for investing your time in contributing to our project! ✨

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

Issues

Create a new issue

If you spot a problem with any chart, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See "Label reference" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

1. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• Using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

2. 🌱 Setup your local workstation

   1. Install the most recent version of task, see the installation docs for other supported platforms.

      # Homebrew
      brew install go-task

   2. Install the additional required CLI tools

      📍 Not using Homebrew? Try using the generic Linux task below, if that fails check out the Brewfile) for what CLI tools needed and install them.

      # Homebrew
      task workstation:brew
      # or, Generic Linux (YMMV, this pulls binaires in to ./bin)
      task workstation:generic-linux

3. Create a working branch and start with your changes!

4. Once your are happy with your changes:

   1. Update the chart version from the hack directory:

      ./update-version.sh <UPDATE_TYPE> ../charts/<CHART_NAME>/Chart.yaml
      # Example: ./update-version.sh minor ../charts/homarr/Chart.yaml

      📍 Update types available : major, minor or patch

   2. Change the artifacthub.io/changes label on Chart.yaml :

      ./update-changelog.sh "<CHANGE_KIND>" "<DESCRIPTION>" ../charts/<CHART_NAME>/Chart.yaml
      # Example: ./update-changelog.sh "fixed" "hot fix" ../charts/homarr/Chart.yaml

      📍 change kinds available : added, changed or fixed

   3. Commit your update.

   4. When you're finished with the changes, create a pull request.