Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (115 loc) · 7.95 KB

CONTRIBUTING.md

File metadata and controls

171 lines (115 loc) · 7.95 KB

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.

Coding with AI

We accept the use of AI-powered tools (GitHub Copilot, ChatGPT, Claude, Cursor, etc.) for contributions, whether for code, tests, or documentation.

⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensure the quality of contributions.

What we expect:

  • Disclose AI usage: A simple note like "Used GitHub Copilot for autocompletion" or "Generated initial test structure with ChatGPT" is sufficient.
  • Specify the scope: Indicate which parts of your contribution involved AI assistance.
  • Review AI-generated content: Ensure you understand and have verified any AI-generated code before submitting.

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-ruby 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 your changes on your branch. If you use AI tools during your work, remember to disclose it in your PR description (see Coding with AI).
  6. Submit the branch as a PR pointing to the main branch of the main meilisearch-ruby 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

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 "bundle install && bundle exec rspec && bundle exec rubocop"

To install dependencies:

bundle install

Tests

Each PR should pass the tests to be accepted.

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

To launch a specific folder or file:

bundle exec rspec spec/meilisearch/index/base_spec.rb

To launch a single test in a specific file:

bundle exec rspec spec/meilisearch/index/search_spec.rb -e 'does a basic search in index'

Linter

Each PR should pass the linter to be accepted.

# Check the linter errors
bundle exec rubocop lib/ spec/
# Auto-correct the linter errors
bundle exec rubocop -a lib/ spec/

If you think the remaining linter errors are acceptable, do not add any rubocop in-line comments in the code.
This project uses a rubocop_todo.yml file that is generated. Do not modify this file manually.
To update it, run the following command:

bundle exec rubocop --auto-gen-config

Want to debug?

You can use the byebug gem.

To create a breakpoint, just add this line in you code:

...
byebug
...

The byebug gem is already imported in all the spec files.
But if you want to use it in the source files you need to add this line at the top of the file:

require 'byebug'

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

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

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

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