Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

112 lines (80 loc) · 4.51 KB
Raw

Contributing

First, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to start contributing to MeiliSearch. The following TOC is sorted progressively, starting with the basics and expanding into more specifics.

  1. Assumptions
  2. Your First Contribution
  3. Change Control
    1. Git Branches
    2. Git Commits
      1. Style
    3. Github Pull Requests
      1. Reviews & Approvals
      2. Merge Style
    4. CI
  4. Development
    1. Setup
    2. Testing
    3. Benchmarking
  5. Humans
    1. Documentation
    2. Changelog

Assumptions

  1. You're familiar with Github and the pull request workflow.
  2. You've read the MeiliSearch docs.
  3. You know about the MeiliSearch community. Please use this for help.

Your First Contribution

  1. 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.
  2. Once approved, fork the MeiliSearch repository in your own Github account.
  3. Create a new Git branch
  4. Review the MeiliSearch workflow and development.
  5. Make your changes.
  6. Submit the branch as a pull request to the main MeiliSearch repo. A MeiliSearch team member should comment and/or review your pull request with a few days. Although, depending on the circumstances, it may take longer.

Change Control

Git Branches

All changes must be made in a branch and submitted as pull requests. MeiliSearch does not adopt any type of branch naming style, but please use something descriptive of your changes.

Git Commits

Style

Please ensure your commits are small and focused; they should tell a story of your change. This helps reviewers to follow your changes, especially for more complex changes.

Familiarise yourself with How to Write a Git Commit Message.

Github Pull Requests

Once your changes are ready you must submit your branch as a pull request.

Reviews & Approvals

All pull requests must be reviewed and approved by at least one MeiliSearch team member.

Merge Style

All pull requests are squashed and merged. We generally discourage large pull requests that are over 300-500 lines of diff. If you would like to propose a change that is larger we suggest coming onto our chat channel and discuss it with one of our engineers. This way we can talk through the solution and discuss if a change that large is even needed! This overall will produce a quicker response to the change and likely produce code that aligns better with our process.

Development

Setup

See the MeiliSearch Docs for how to set up a development environment.

Benchmarking & Profiling

We do not yet do any benchmarking, nor have we formalised our profiling. If you'd like to work on this please get in touch!

Humans

After making your change, you'll want to prepare it for MeiliSearch users (mostly humans). This usually entails updating documentation and announcing your feature.

Documentation

Documentation is very important to MeiliSearch. All contributions that alter user-facing behavior MUST include documentation changes. Please see GitHub.com/meilisearch/documentation for more info.

Changelog

Until we have guidelines in place, updating the Changelog is solely the responsibility of MeiliSearch team members.