First, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to start contributing to Meilisearch.
Remember that there are many ways to contribute other than writing code: writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests...
Meilisearch can manage multiple indexes, handle the update store, and expose an HTTP API. Search and indexation are the domain of our core engine, milli
, while tokenization is handled by our charabia
library.
If Meilisearch does not offer optimized support for your language, please consider contributing to charabia
by following the CONTRIBUTING.md file and integrating your intended normalizer/segmenter.
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.cargo run --release
We recommend using the --release
flag to test the full performance of Meilisearch.
cargo test
This command will be triggered to each PR as a requirement for merging it.
We are using insta to perform snapshot-based testing.
We recommend using the insta tooling (such as cargo-insta
) to update the snapshots if they change following a PR.
New tests should use insta where possible rather than manual assert
statements.
Furthermore, we provide some macros on top of insta, notably a way to use snapshot hashes instead of inline snapshots, saving a lot of space in the repository.
To effectively debug snapshot-based hashes, we recommend you export the MEILI_TEST_FULL_SNAPS
environment variable so that snapshot are fully created locally:
export MEILI_TEST_FULL_SNAPS=true # add this to your .bashrc, .zshrc, ...
If you get a "Too many open files" error you might want to increase the open file limit using this command:
ulimit -Sn 3000
Meilisearch follows the cargo xtask workflow to provide some build tools.
Run cargo xtask --help
from the root of the repository to find out what is available.
Meilisearch uses tracing
for logging purposes. Tracing logs are structured and can be displayed as JSON to the end user, so prefer passing arguments as fields rather than interpolating them in the message.
Refer to the documentation for the syntax of the spans and events.
Logging spans are used for 3 distinct purposes:
As a result, the spans should follow some rules:
TRACE
level.target
prefixes:
indexing::
for spans meant when profiling the indexing operations.search::
for spans meant when profiling the search operations.See BENCHMARKS.md
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.
As minimal requirements, your commit message should:
We don't follow any other convention, but if you want to use one, we recommend the Chris Beams one.
Some notes on GitHub PRs:
main
before merging. Fortunately, this project uses Bors to automatically enforce this requirement without the PR author having to rebase manually.Meilisearch tools follow the Semantic Versioning Convention.
This project integrates a bot that helps us manage pull requests merging.
Read more about this.
The full Meilisearch release process is described in this guide. Please follow it carefully before doing any release.
Depending on the developed feature, you might need to provide a prototyped version of Meilisearch to make it easier to test by the users.
This happens in two steps:
For each release, the following assets are created:
vX.Y.Z
vX.Y
(not published for RC)latest
(not published for RC)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 ❤️
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。