Contributing

First, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to start contributing to MeiliSearch.

Hacktoberfest
Assumptions
How to Contribute
Development Workflow
Git Guidelines

Hacktoberfest

It's Hacktoberfest month! 🥳

🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!

✅ To be accepted it has either to have been merged, approved or tagged with the hacktoberest-accepted label.

🧐 Don't forget to check the quality standards, otherwise your PR could be marked as spam or invalid, and it will not be counted toward your participation in Hacktoberfest.

Assumptions

You're familiar with Github and the Pull Requests(PR) workflow.
You've read the MeiliSearch documentation.
You know about the MeiliSearch community. Please use this for help.

How to Contribute

Ensure your change has an issue! Find an existing issue or open a new issue.
- This is where you can get a feel if the change will be accepted or not.
Once approved, fork the MeiliSearch repository in your own Github account.
Create a new Git branch
Review the Development Workflow section that describes the steps to maintain the repository.
Make your changes on your branch.
Submit the branch as a Pull Request pointing to the main branch of the 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.

Development Workflow

Setup and run MeiliSearch

cargo run --release

We recommend using the --release flag to test the full performance of MeiliSearch.

Test

cargo test

If you get a "Too many open files" error you might want to increase the open file limit using this command:

ulimit -Sn 3000

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 the Chris Beams one.

Github Pull Requests

Some notes on GitHub PRs:

All PRs must be reviewed and approved by at least one maintainer.
The PR title should be accurate and descriptive of the changes.
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 PRs are recommended when 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 uses Bors to automatically enforce this requirement without the PR author having to rebase manually.

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

4.4 KiB Raw Blame History