Skip to content

Latest commit

 

History

History
157 lines (104 loc) · 7.86 KB

CONTRIBUTING.md

File metadata and controls

157 lines (104 loc) · 7.86 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 gatsby-plugin-meilisearch 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 gatsby-plugin-meilisearch 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

We suggest using yarn as the lock file is in yarn and thus we ensure a working dev environment.

yarn

Tests and Linter

Each PR should pass the tests and the linter to be accepted.

# Run a MeiliSearch instance
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true

# Tests the project
yarn test # integration tests
yarn test:e2e # end to end tests

# Tests the project in watch/open mode
yarn test:watch
yarn test:e2e:watch

# Linter
yarn lint
# Linter with fixing
yarn lint:fix

Some environement variables are needed in order to run the test command: MEILI_HTTP_ADDR, MEILI_MASTER_KEY, and MEILI_INDEX_NAME. It is possible to provide them in a .env file inside the tests folder.

Example of .env:

MEILI_HTTP_ADDR="http://localhost:7700"
MEILI_MASTER_KEY="masterKey"
MEILI_INDEX_NAME="my_index"

Run Playground

To test directly your changes with watch mode, you can run the Gatsby playground:

# Root of repository
yarn playground:dev

This command will install the required dependencies, build the project, and serve it. You should be able to reach it on the port 9000 of your localhost.

You may also just want to generate a build without serving it. If so, run the following command:

yarn playground:build

If you want to specify your host, API key and index name, you can do so by editing the gatsby-config.js file, as well as the src/pages/index.js file if you want to test the playground's front-end. Alternatively, you can set the environment variables GATSBY_MEILI_HTTP_ADDR, GATSBY_MEILI_MASTER_KEY, and GATSBY_MEILI_INDEX_NAME. It is possible to provide them in a .env file at the root of the playground.

Example of .env:

GATSBY_MEILI_HTTP_ADDR="http://localhost:7700"
GATSBY_MEILI_MASTER_KEY="masterKey"
GATSBY_MEILI_INDEX_NAME="my_index"

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 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.

Automated Changelogs

This project integrates a tool to create automated changelogs.
Read more about this.

How to Publish the Release

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

Make a PR modifying the file package.json with the right version.

"version": "X.X.X",

Once the changes are merged on main, you can publish the current draft release via the GitHub interface: on this page, click on Edit (related to the draft release) > update the description (be sure you apply these recommandations) > when you are ready, click on Publish release.

GitHub Actions will be triggered and push the package to npm.

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 ❤️