Skip to content
This repository was archived by the owner on May 9, 2023. It is now read-only.

Latest commit

 

History

History
106 lines (71 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

106 lines (71 loc) · 6.29 KB

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 cloud-scripts 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. Make the changes on your branch.
  5. Submit the branch as a PR pointing to the main branch of the main cloud-scripts 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.

You can check out the longer, more complete guideline documentation here.

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. If it's not, you have to rebase your branch. Check out this quick tutorial to successfully apply the rebase from a forked repository.
  • All PRs must be reviewed and approved by at least one maintainer.
  • The PR title should be accurate and descriptive of the changes.

Release Process (for internal team only)

The release tags of this package follow exactly the Meilisearch versions.
It means that, for example, the v0.17.0 tag in this repository corresponds to the scripts for deploying Meilisearch v0.17.0.

This repository currently does not provide any automated way to test and release the cloud scripts.
Please, follow carefully the steps in the next sections before any release.

Test before Releasing

  1. In scripts/cloud-config.yaml, update the Meilisearch version used in the wget command of the runcmd section. Use the version number that you want to release, in the format: vX.X.X. If you want to test with a Meilisearch RC, replace it by the right RC version tag (vX.X.XrcX).

  2. Commit your changes on a new branch.

  3. Create a git tag on the last commit of your recently created branch:

git tag vX.X.X
git push origin vX.X.X
  1. Test the script: changes in this repository can not be tested by themselves. Other repositories, as meilisearch-digitalocean or meilisearch-aws use this scripts to configure instances on the respective cloud provider. In order to test any changes in this repository, you need to run the tests of those repositories. For example:
  1. If you are testing a Release Candidate of Meilisearch (vX.X.XrcX) version of Meilisearch, please delete the tag after testing.
$ git tag -d vX.X.XrcX
$ git push --delete origin vX.X.XrcX

Release

⚠️ This process shouldn't be followed when testing a RC version of Meilisearch.

  1. Create a PR pointing to main branch and merge it.

  2. Move the tag to the last commit of the main branch.

$ git tag -d vX.X.X
$ git push --delete origin vX.X.X
$ git checkout main
$ git pull origin main
$ git tag vX.X.X
$ git push origin vX.X.X

Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️