Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
247 lines (165 loc) · 9.71 KB

CONTRIBUTING.md

File metadata and controls

247 lines (165 loc) · 9.71 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-java 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-java 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 "./gradlew build && ./gradlew build integrationTest"

To install dependencies:

./gradlew build

Tests

Integration and unit tests will be run in your PR to check everything is OK. Each PR should pass all the tests to be accepted.

To run the unit tests in your local environment, use:

./gradlew test

You can also launch the integration tests, which run against a local Meilisearch instance. To make it run in your local environment, use:

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

Linter

Run:

bash ./scripts/lint.sh

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 following files with the right version:

VERSION = "X.X.X";
version = 'X.X.X'
<version>X.X.X</version>
implementation 'com.meilisearch.sdk:meilisearch-java:X.X.X'
<version>X.X.X</version>
implementation 'com.meilisearch.sdk:meilisearch-java: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.

A GitHub Action will be triggered and publish a new release to Maven repository.

How to Manually Publish the Release to Maven repository

⚠️ These following steps should only be applied if it's impossible to release the current version in the Maven repository via the CI. Keep in mind publishing via the CI should always be privileged.

Create signature credentials (first time)

⚠️ These step (create and publish a GPG key) has already been done by the Meili team and the key is shared internally. Please ask a maintainer to get the credentials if needed.

Steps:

  1. Install gpg
sudo apt install gnupg

or

brew install gpg
  1. Create a genkey file
Key-Type: 1
Key-Length: 4096
Subkey-Type: 1
Subkey-Length: 4096
Name-Real: <your-name>
Name-Email: <your-email>
Expire-Date: 0
Passphrase: <your-passphrase>
  1. Create a gpg key
# May need sudo privilege
gpg --gen-key --batch genkey
  1. Publish your public key to a public repository:
gpg --keyserver hkp://keyserver.ubuntu.com --send-keys <last-8-digits-of-your-key-hash>
  1. Export the gpg key in a signing-key.asc armored file
gpg --armor --export-secret-keys $KEY_ID > signing-key.asc

Sign your files and upload to Maven Repository manually

  1. Set the environment variables listed below with the required credentials:
export MAVEN_CENTRAL_USERNAME=<maven-username>
export MAVEN_CENTRAL_PASSWORD=<maven-password>

export SIGNINT_KEY_ID=<id-associated-to-the-gpg-key>
export SIGNING_PASSWORD=<passphrase-associated-to-the-gpg-key>
  1. Decode the gpg key
base64 -d $SIGNING_SECRET_KEY_RING_FILE > secring.gpg
  1. Build, sign your files and upload them to Maven repository:
# May need sudo privilege and JDK8
./gradlew build
TODO
  1. Login to Sonatype Nexus.
  2. Navigate to Deployments.
  3. Checks will be made by Sonatype. It might take time. If any error occurs, it will be visible in the Deployments tab (last one).
  4. Once the check have succeeded, the release will be now processed and it will appear in Maven Central.

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