Skip to content

Latest commit

 

History

History
215 lines (140 loc) · 8.45 KB

CONTRIBUTING.md

File metadata and controls

215 lines (140 loc) · 8.45 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-rust 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-rust 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

You can set up your local environment natively or using docker, check out the docker-compose.yml.

Example of running all the checks with docker:

docker-compose run --rm package bash -c "cargo test"

To install dependencies:

cargo build --release

To ensure the same dependency versions in all environments, for example the CI, update the dependencies by running: cargo update.

Tests

To run the tests, run:

# Tests
curl -L https://install.meilisearch.com | sh # download Meilisearch
./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
cargo test

There are two kinds of tests, documentation tests and unit tests. If you need to write or read the unit tests you should consider reading this readme about our custom testing macro.

Also, the WASM example compilation should be checked:

rustup target add wasm32-unknown-unknown
cargo check -p web_app --target wasm32-unknown-unknown

Each PR should pass the tests to be accepted.

Clippy

Each PR should pass clippy (the linter) to be accepted.

cargo clippy -- -D warnings

If you don't have clippy installed on your machine yet, run:

rustup update
rustup component add clippy

⚠️ Also, if you have installed clippy a long time ago, you might need to update it:

rustup update

Fmt

Each PR should pass the format test to be accepted.

Run the following to fix the formatting errors:

cargo fmt

and the following to test if the formatting is correct:

cargo fmt --all -- --check

Update the README

The README is generated. Please do not update manually the README.md file.

Instead, update the README.tpl and src/lib.rs files, and run:

sh scripts/update-readme.sh

Then, push the changed files.

You can check the current README.md is up-to-date by running:

sh scripts/check-readme.sh
# To see the diff
sh scripts/check-readme.sh --diff

If it's not, the CI will fail on your PR.

Yaml lint

To check if your yaml files are correctly formatted, you need to install yamllint and then run yamllint .

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

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 get through the guide about Releasing an Integration.

Make a PR modifying the file Cargo.toml:

version = "X.X.X"

the README.tpl:

//! meilisearch-sdk = "X.X.X"

and the code-samples file:

  meilisearch-sdk = "X.X.X"

with the right version.

After the changes on Cargo.toml, run the following command:

sh scripts/update_macro_versions.sh

After the changes on lib.rs, run the following command:

sh scripts/update-readme.sh

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 recommendations) > when you are ready, click on Publish release.

GitHub Actions will be triggered and push the package to crates.io.

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