diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..65b78060 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,105 @@ +# 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](#assumptions) +- [How to Contribute](#how-to-contribute) +- [Development Workflow](#development-workflow) +- [Git Guidelines](#git-guidelines) + + + +## Assumptions + +1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** +2. **You've read the MeiliSearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** +3. **You know about the [MeiliSearch community](https://docs.meilisearch.com/resources/contact.html). 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](https://github.com/meilisearch/meilisearch-rust/issues/) or [open a new one](https://github.com/meilisearch/meilisearch-rust/issues/new). +2. Once done, [fork the meilisearch-rust repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) 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](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository). +4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository. +5. Make your changes. +6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `master` branch of the main meilisearch-rust 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](https://github.com/meilisearch/meilisearch-rust/releases/). + +## Development Workflow + +### Tests + +All the tests are documentation tests.
+Since they are all making operations on the MeiliSearch server, running all the tests simultaneously would cause panics. + +To run the tests one by one, run: + +```bash +# Tests +$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub +$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics +$ cargo test -- --test-threads=1 +``` + +Each PR should pass the tests to be accepted. + +### Release Process + +MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). + +#### Automated Changelogs + +For each PR merged on `master`, a GitHub Action is running and updates the next release description as a draft release in the [GitHub interface](https://github.com/meilisearch/meilisearch-rust/releases). If you don't have the right access to this repository, you will not be able to see the draft release until the release is published. + +The draft release description is therefore generated and corresponds to all the PRs titles since the previous release. This means each PR should only do one change and the title should be descriptive of this change. + +About this automation: +- As the draft release description is generated on every push on `master`, don't change it manually until the final release publishment. +- If you don't want a PR to appear in the release changelogs: add the label `skip-changelog`. We suggest removing PRs updating the README or the CI (except for big changes). +- If the changes you are doing in the PR are breaking: add the label `breaking-change`. In the release tag, the minor will be increased instead of the patch. The major will never be changed until [MeiliSearch](https://github.com/meilisearch/MeiliSearch) is stable. +- If you did any mistake, for example the PR is already closed but you forgot to add a label or you misnamed your PR, don't panic: change what you want in the closed PR and run the job again. + +*More information about the [Release Drafter](https://github.com/release-drafter/release-drafter), used to automate these steps.* + +#### How to Publish the Release + +Make a PR modifying the file [`Cargo.toml`](/Cargo.toml) with the right version. + +```ruby +version = "X.X.X" +``` + +Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-rust/releases). + +A GitHub Action will be triggered and push the package to [crates.io](https://crates.io/crates/meilisearch-sdk). + +## 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](https://chris.beams.io/posts/git-commit/). + +### GitHub Pull Requests + +Some notes on GitHub PRs: +- [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) 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 `master`** before merging. You need to [rebase your branch](https://gist.github.com/curquiza/5f7ce615f85331f083cd467fc4e19398) if it is not. +- All PRs must be reviewed and approved by at least one maintainer. +- All PRs have to be **squashed and merged**. +- 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 changlogs](https://github.com/meilisearch/meilisearch-rust/releases/). + +Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️ diff --git a/Cargo.toml b/Cargo.toml index 431e51af..c92a7e6a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,10 +3,10 @@ name = "meilisearch-sdk" version = "0.2.0" authors = ["Mubelotix "] edition = "2018" -description = "MeiliSearch Rust SDK. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine." +description = "Rust wrapper for the MeiliSearch API. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine." license = "MIT" readme = "README.md" -repository = "https://github.com/Mubelotix/meilisearch-sdk" +repository = "https://github.com/meilisearch/meilisearch-sdk" [dependencies] serde_json = "1.0" diff --git a/README.md b/README.md index 0246ae28..eb1433c3 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,80 @@ -# meilisearch-sdk (WIP) [![Latest Version]][crates.io] -[Latest Version]: https://img.shields.io/crates/v/meilisearch-sdk -[crates.io]: https://crates.io/crates/meilisearch-sdk +

+ MeiliSearch-Dotnet +

-MeiliSearch-sdk is an async client for [MeiliSearch](https://www.meilisearch.com/) written in Rust. -[MeiliSearch](https://www.meilisearch.com/) is a powerful, fast, open-source, easy to use and deploy search engine. -Both searching and indexing are highly customizable. -Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. +

MeiliSearch Rust SDK (WIP)

+ +

+ MeiliSearch | + Website | + Blog | + Twitter | + Documentation | + FAQ +

+ +

+ crates.io + Tests + License + + Slack +

+ +

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Rust

+ +**MeiliSearch Rust** is a client for **MeiliSearch** written in Rust. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. ### Table of Contents + - [🔧 Installation](#-installation) - [🚀 Getting Started](#-getting-started) -- [🌐 Running in the browser with WASM](#-running-in-the-browser-with-wasm) - [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch) -- [Running the tests](#running-the-tests) +- [🎬 Examples](#-examples) +- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm) +- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing) ## 🔧 Installation -This crate requires a MeiliSearch server to run. See [here](https://docs.meilisearch.com/guides/advanced_guides/installation.html#download-and-launch) to install and run MeiliSearch. +To use `meilisearch-sdk`, add this to your `Cargo.toml`: -Then, put `meilisearch-sdk = "0.1"` in your Cargo.toml, as usual. +```toml +[dependencies] +meilisearch-sdk = "0.2" +``` -Since this crate is async, you have to run your program in the tokio runtime (cf the example below). You will need `tokio = { version = "0.2", features=["macros"] }` in your Cargo.toml. When targetting Wasm, the browser will replace tokio. +The following optional dependencies may also be useful: + +```toml +tokio = { version = "0.2", features = ["macros"] } +serde = { version="1.0", features = ["derive"] } +``` + +Since this crate is async, you have to run your program in the [tokio](https://crates.io/crates/tokio) runtime. When targetting Wasm, the browser will replace tokio. Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde. -Add `serde = {version="1.0", features=["derive"]}` in your Cargo.toml. + +### Run a MeiliSearch Instance + +This crate requires a MeiliSearch server to run. + +There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/guides/advanced_guides/installation.html#download-and-launch). + +For example, if you use Docker: +```bash +$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub +$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey +``` + +NB: you can also download MeiliSearch from **Homebrew** or **APT**. + ## 🚀 Getting Started Here is a quickstart for a search request (please follow the [installation](#-installation) steps before) ```rust -use meilisearch_sdk::{document::*, indexes::*, client::*, search::*}; +use meilisearch_sdk::{document::*, client::*, search::*}; use serde::{Serialize, Deserialize}; #[derive(Serialize, Deserialize, Debug)] @@ -54,7 +98,7 @@ async fn main() { let client = Client::new("http://localhost:7700", "masterKey"); // Get the index called "books" - let mut books = client.get_or_create("books").await.unwrap(); + let books = client.get_or_create("books").await.unwrap(); // Add some books in the index books.add_documents(&[ @@ -78,23 +122,32 @@ Output: [Book { book_id: 4, title: "Harry Potter and the Half-Blood Prince" }] ``` -## 🌐 Running in the browser with WASM +## 🤖 Compatibility with MeiliSearch -This crate fully supports WASM. The only difference between the WASM and the native version is that the native version has one more variant (Error::Http) in the Error enum. That should not matter so much but we could add this variant in WASM too. -However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using meilisearch, see the [tutorial (not available yet)](). +This package is compatible with the following MeiliSearch versions: +- `v0.12.X` +- `v0.11.X` -WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extension). +## 🎬 Examples -## 🤖 Compatibility with MeiliSearch +_TODO_ + +## 🌐 Running in the Browser with WASM + +This crate fully supports WASM. + +The only difference between the WASM and the native version is that the native version has one more variant (`Error::Http`) in the Error enum. That should not matter so much but we could add this variant in WASM too. + +However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using MeiliSearch, see the [tutorial (not available yet)](). + +WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extension). -This crate is currently supporting MeiliSearch v11.0 and will be maintained. +## ⚙️ Development Workflow and Contributing -## Running the tests +Any new contribution is more than welcome in this project! -All the tests are documentation tests. -Since they are all making operations on the MeiliSearch server, running all the tests simultaneously would cause panics. -To run the tests one by one, run `cargo test -- --test-threads=1`. +If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions! -Current version: 0.1.4 +
-License: MIT +**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.