Skip to content


Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given. You can contribute in many ways.

Types of Contributions

Report Bugs

Report bugs at

If you are reporting a bug, please use the bug report template, and include:

  • your operating system name and version
  • any details about your local setup that might be helpful in troubleshooting
  • detailed steps to reproduce the bug
  • infrastructure provider specific details

Fix Bugs

Look through the GitLab issues for bugs. Anything tagged with "bug" and/or "help wanted" is open to whoever wants to fix it.

Implement Features

Look through the GitLab issues for features. Anything tagged with "enhancement" and/or "help wanted" is open to whoever wants to implement it.

Write Documentation

Grove could always use more documentation, whether as part of the docs, in docstrings, comments, and such.

Submit Feedback

The best way to send feedback is to file an issue.

If you are proposing a feature:

  • explain in detail how it would work
  • keep the scope as narrow as possible, to make it easier to implement
  • remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started

Ready to contribute?

  1. Fork repository
  2. Follow for setting up a cluster for testing. Please note that using cloud infrastructure will incur some costs.
  3. Install prerequisites

    # Remember, we use my-repository for the grove-template fork's name
    cd my-repository/grove
    python -m virtualenv virtualenv
    source virtualenv/bin/activate
    pip install -r tools-container/requirements.txt
    npm install markdownlint-cli
    # Install git-cliff for changelog generation
    # Instructions:
  4. Create a branch for local development

    git checkout -b gitlab-username/bugfix-or-feature-name
  5. When you're done making changes in Grove CLI, check that your changes are formatted, passing linters, and tests are succeeding. We use CI_PROJECT_DIR="$(pwd)/../../../" make test to run the tests as

    cd tools-container/grove-cli
    make format
    make lint
    # Set my-repository for the CI_PROJECT_DIR variable and run the tests
    CI_PROJECT_DIR="$(pwd)/../../../" make test
  6. Update documentation as necessary, and check the results. When adding or reorganizing docs, ensure the mkdocs.yml file is updated accordingly.

    # source the virtualenv if not already sourced
    pip install -r
    npx markdownlint-cli docs
    make serve
  7. Commit your changes and push your branch to GitLab. We use conventional commits, and we require every commit to follow this pattern.

    git add .
    git commit -m "action(scope): summary"
    git push origin gitlab-username/bugfix-or-feature-name
  8. Submit a merge request on GitLab

Merge Request Guidelines

Before you submit a merge request, check that it meets these guidelines:

  1. The merge request should include tests if applicable
  2. If tests are applicable, tests should pass for the merge request
  3. If the merge request adds new functionality, or changes existing one, the docs should be updated
  4. After merging a Merge Request, run git cliff > on the main branch and push changes to main using git commit -sm "chore(changelog): update changelog"

Release Guidelines

Release guideline is defined by the releases discovery. Ensuring the changelog is maintained properly since the first tag, the commits are validated by commit lint and changelog is generated by git cliff.

Therefore to have proper release notes, follow the steps below:

  1. Double-check past commits that nothing missed
  2. Run git cliff --tag v<x.x.x> --unreleased --prepend and validate changes, where <x.x.x> is the upcoming release version
  3. Validate changes in
  4. Commit the changes using git commit -sm "chore(changelog): update changelog"
  5. Run git tag v<x.x.x> -sm "chore(release): cut release v<x.x.x>", where <x.x.x> is the upcoming release version
  6. Run git push origin main and git push v<x.x.x>, where <x.x.x> is the new release version
  7. Using GitLab Releases, create a new release and form a release notes based on the latest changelog additions
  8. Update the grove-template repository

In case of any questions, check the workflow defined in the discovery.