Skip to content

Latest commit

 

History

History
180 lines (126 loc) · 8.71 KB

CONTRIBUTING.md

File metadata and controls

180 lines (126 loc) · 8.71 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-dart 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-dart 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

Requirements

Install the official Dart SDK or the Flutter SDK (which includes Dart SDK) using guides on the official website.

Both of them include pub.

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 "dart pub get && dart run test --concurrency=4 && dart analyze && dart format . --set-exit-if-changed"

To install dependencies:

dart pub get

This package relies on build_runner to generate serialization information for some models, to re-generate files after making any changes, run:

dart run build_runner build

Tests and Linter

Each PR should pass the tests and the linter to be accepted.

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

Updating code samples

Some PRs require updating the code samples (found in .code-samples.meilisearch.yaml), this is done automatically using code excerpts, which are actual pieces of code subject to testing and linting.

A lot of them are placed in test/code_samples.dart.

Also most of the tests in that file are skipped, since they are mostly duplicated in other test files.

The process to define a new code sample is as follows:

  1. Add the piece of code in test/code_samples.dart
  2. surround it with #docregion key and #enddocregion, e.g. 
    // #docregion meilisearch_contributing_1
final client = MeilisearchClient();
anything();    
// #enddocregion
  3. run this command to update the code samples 
    dart run ./tool/bin/meili.dart update-samples
  4. to test if the code samples are updated correctly, run: 
    dart run ./tool/bin/meili.dart update-samples --fail-on-change

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

Make a PR modifying the version in:

static const String current = 'X.X.X';
version: X.X.X
dependencies:
  meilisearch: ^X.X.X

Also in this PR, update the CHANGELOG.md file with the description of the next release.

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.

A GitHub Action will be triggered and push the package to pub.dev.

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