Skip to content

Latest commit

 

History

History
152 lines (98 loc) · 8.02 KB

CONTRIBUTING.md

File metadata and controls

152 lines (98 loc) · 8.02 KB
Raw

Contributing

First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.

Assumptions

  1. You're familiar with GitHub and the Pull Request(PR) workflow.
  2. You've read the Meilisearch documentation and the README.
  3. You know about the Meilisearch community. Please use this for help.

How to Contribute

  1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an existing issue or open a new one.
  2. Once done, fork the meilisearch-kubernetes repository in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
  3. Create a new Git branch.
  4. Review the Development Workflow section that describes the steps to maintain the repository.
  5. Make the changes on your branch.
  6. Submit the branch as a PR pointing to the main branch of the main meilisearch-kubernetes repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
    We do not enforce a naming convention for the PRs, but please use something descriptive of your changes, having in mind that the title of your PR will be automatically added to the next release changelog.

Development Workflow

Setup

In order to use the different tools on this repository, you will first need to:

  • Install Kubectl on your machine. This will allow you to run commands against your Kubernetes cluster with the kubectl command.

  • Install Helm. This will allow you to run the helm command, enabling the installation and manipulation of Helm charts.

  • A Kubernetes cluster up and running. Any Kubernetes cluster can be used, on the cloud or locally installed on your machine. This can be easily achieved by installing minikube, and creating a local cluster by running:

minikube start

You can install and test the Helm chart by running:

helm install meilisearch-chart-test -f charts/meilisearch/values.yaml charts/meilisearch

An easy way to access your Meilisearch instance and test that it is up and running is by using port-forwarding. This can be achieved by running:

kubectl port-forward --namespace default svc/meilisearch 7700:7700

Finally, to uninstall the chart, run:

helm uninstall meilisearch-chart-test

Tests and Linter

Each PR should pass the linter to be accepted.

# Linter
helm lint charts/meilisearch

Each PR should also check if the generated file manifests/meilisearch.yaml is updated with the new modifications. You can generated the manifest with the command line:

helm template meilisearch charts/meilisearch | grep -v 'helm.sh/chart:\|app.kubernetes.io/managed-by:' > manifests/meilisearch.yaml

Or just by comment the PR:

@meilisearch sync-manifest

Additionally, the GitHub CI will run a test to check if there are changes introduced to the charts. If changes were introduced, it will require you to update the Chart version.

Generate Documentation

Documentation for this repository is currently autogenerated using by helm-docs.

At each PR, you must check that the documentation has been correctly updated.

  • Install helm-docs on your machine.

  • Run and generate documentation:

    helm-docs

  • Then commit your changes in your PR.

Git Guidelines

Git Branches

All changes must be made in a branch and submitted as PR. We do not enforce any branch naming style, but please use something descriptive of your changes.

Git Guidelines

Git Branches

All changes must be made in a branch and submitted as PR. We do not enforce any branch naming style, but please use something descriptive of your changes.

Git Commits

As minimal requirements, your commit message should:

  • be capitalized
  • not finish by a dot or any other punctuation character (!,?)
  • start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message. e.g.: "Fix the home page button" or "Add more tests for create_index method"

We don't follow any other convention, but if you want to use one, we recommend this one.

GitHub Pull Requests

Some notes on GitHub PRs:

  • Convert your PR as a draft if your changes are a work in progress: no one will review it until you pass your PR as ready for review.
    The draft PR can be very useful if you want to show that you are working on something and make your work visible.
  • The branch related to the PR must be up-to-date with main before merging. Fortunately, this project integrates a bot to automatically enforce this requirement without the PR author having to do it manually.
  • All PRs must be reviewed and approved by at least one maintainer.
  • The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next release changelogs.

Release Process (for the internal team only)

Meilisearch tools follow the Semantic Versioning Convention.

Automation to Rebase and Merge the PRs

This project integrates a bot that helps us manage pull requests merging.
Read more about this.

How to Publish the Release

⚠️ Before doing anything, make sure you got through the guide about Releasing an Integration.

⚠️ Every PR that is merged to main introducing changes to the Helm Chart needs to modify the file charts/meilisearch/Chart.yaml, by increasing the version of the chart accordingly.

Every PR that is merged to main triggers the automated release process, as specified at .github/workflows/release-chart.yaml. A GitHub Action will be triggered and publish a new release on the GitHub repository releases. This will enable users to start using the new version of the chart immediately after publishing.

Thank you again for reading this through. We can not wait to begin to work with you if you make your way through this contributing guide ❤️