Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
164 lines (109 loc) · 8.79 KB

CONTRIBUTING.md

File metadata and controls

164 lines (109 loc) · 8.79 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.

Hacktoberfest 2022

It's Hacktoberfest month! 🥳

Thanks so much for participating with Meilisearch this year!

  1. We will follow the quality standards set by the organizers of Hacktoberfest (see detail on their website). Our reviewers will not consider any PR that doesn’t match that standard.
  2. PRs reviews will take place from Monday to Thursday, during usual working hours, CEST time. If you submit outside of these hours, there’s no need to panic; we will get around to your contribution.
  3. There will be no issue assignment as we don’t want people to ask to be assigned specific issues and never return, discouraging the volunteer contributors from opening a PR to fix this issue. We take the liberty to choose the PR that best fixes the issue, so we encourage you to get to it as soon as possible and do your best!

You can check out the longer, more complete guideline documentation here.

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-swift 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-swift 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 changelogs.

Development Workflow

On a terminal

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 "swift test && swift run swiftlint"

To install dependencies:

swift build

Tests and Linter

If you have a running Meilisearch instance at port localhost:7700 with the following master key: masterKey, you will need to run the following command to test the package:

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

If you do not have a Meilisearch instance with the previous mentioned parameters, you can run the test script that will automatically run a Docker container with Meilisearch and start the test:

./Scripts/run-test.sh

If you want to run the linter swiftlint:

swift run swiftlint

If you want to fix your linting errors:

swift run swiftlint --fix

Setup on Xcode

To build the project, if it's not already done, click on the play button in the top left corner of Xcode.

Tests and linter

To launch the tests:

  • Go to Product > Test
  • Use the shortcut command + U

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 updating the different versions with the new one on these files:

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

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