From 581bc1bcb91915a38fd8694e612d82e60f58f701 Mon Sep 17 00:00:00 2001 From: Clementine Urquizar Date: Thu, 25 Jun 2020 15:25:19 +0200 Subject: [PATCH 01/26] Add CONTRIBUTING.md template file --- templates/CONTRIBUTING.md | 131 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 templates/CONTRIBUTING.md diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md new file mode 100644 index 0000000..812d80c --- /dev/null +++ b/templates/CONTRIBUTING.md @@ -0,0 +1,131 @@ +# Contributing + +--- + +COMMENT TO REMOVE + +Be aware of XXX in sentences and links: they need to be replaced by the name of the repository. + +--- + +First, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to start contributing to MeiliSearch. + + + +- [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 [docs](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. Ensure your change has an issue! Find an [existing issue](https://github.com/meilisearch/XXX/issues/) or [open a new issue](https://github.com/meilisearch/XXX/issues/new). This is where you can get a feel if the change will be accepted or not. +2. Once approved, [fork the XXX repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. +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 XXX repo. A team member should comment and/or review your Pull Request with a few days. Although, depending on the circumstances, it may take longer.
+ About the PR title, we do not adopt any type of naming style, but **please use something descriptive of your changes**. The title of the PR will be indeed automatically added to the next [release changlogs](https://github.com/meilisearch/XXX/releases/). + +## Development Workflow + +--- + +COMMENT TO REMOVE + +This section should be filled according to the repository and should contain: +- A "Setup" section (if needed) with the command to install the dependencies for the contributor (e.g.: `yarn --dev`). +- A "Tests and Linter" section with the command to run the tests, the linter and the linter-autofix (if possible). +- A "Release Process" section that describes the process before publishing a new release. +- Other useful tips/steps for the contributor (e.g.: how to build, how to debug). + +/!\ The following lines are just a template example and should be completed with right names and right commands + +--- + +### Setup + +```bash +$ +``` + +### Tests and Linter + +Each PR should pass the tests and the linter to be accepted. + +```bash +# Tests +$ +$ +# Linter +$ +# Linter with fixing +$ +``` + +### Release Process + +MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). + + +#### Automatiazed 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/XXX/releases). If you don't have the permission to this repository, you will not be able to see the draft release until the release will be 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 desriptive of this change. + +Some points about this automatization: +- 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: set the label `skip-changelog`. We used to remove PRs updating the README or the CI (except for big changes). +- If the changes you are doing in the PR are breaking: set 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 bad-named the title of your PR, don't panic: change what you want in the closed PR and run the job again. + +*More information about [release drafter](https://github.com/release-drafter/release-drafter) we use to automatize these steps.* + +#### How to Publish the Release + +You must do a PR modifying the file `[]`(\) with the right version. + +``` + +``` + +Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/XXX/releases). + +A GitHub Action will be triggered and push the package on [\](\). + +## Git Guidelines + +### Git Branches + +All changes must be made in a branch and submitted as PR. +We do not adopt any type of branch naming style, but please use something descriptive of your changes. + +### Git Commits + +As a minimal requirement, we ask the commit message: +- to be capitalized +- not to finish by a dot or any other punctuation character (!,?) +- to start with a verb so that we can read your commit message this way: "This commmit 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 points about GitHub PR: +- [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 branch related to the PR must be **up-to-date with `master`** before merging. +- All PRs must be reviewed and approved by at least one member. +- 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/XXX/releases/). + + From ec6e2c3d0e66f719817c6260f0772b2acae5ded7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 25 Jun 2020 15:59:03 +0200 Subject: [PATCH 02/26] Update templates/CONTRIBUTING.md Co-authored-by: Thomas Payet --- templates/CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 812d80c..62640e6 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -8,7 +8,7 @@ Be aware of XXX in sentences and links: they need to be replaced by the name of --- -First, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to start contributing to MeiliSearch. +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. @@ -128,4 +128,3 @@ Some points about GitHub PR: - 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/XXX/releases/). - From 6058f7b51e581deba8838b3dcdc5a559e2e7d6da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 25 Jun 2020 15:59:10 +0200 Subject: [PATCH 03/26] Update templates/CONTRIBUTING.md Co-authored-by: Thomas Payet --- templates/CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 62640e6..d740adb 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -4,7 +4,7 @@ COMMENT TO REMOVE -Be aware of XXX in sentences and links: they need to be replaced by the name of the repository. +Be aware of XXX in sentences and links: they need to be replaced by the name of the actual repository. --- @@ -127,4 +127,3 @@ Some points about GitHub PR: - All PRs must be reviewed and approved by at least one member. - 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/XXX/releases/). - From f91bb052ed65822a079eca448d8af5814c7b1bb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 25 Jun 2020 15:59:24 +0200 Subject: [PATCH 04/26] Update templates/CONTRIBUTING.md Co-authored-by: Thomas Payet --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index d740adb..29c768b 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -124,6 +124,6 @@ We don't follow any other convention, but if you want to use one, we recommend [ Some points about GitHub PR: - [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 branch related to the PR must be **up-to-date with `master`** before merging. -- All PRs must be reviewed and approved by at least one member. +- 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/XXX/releases/). From 734d3fd0d9b82990c09fbf7068349c62ec9f146c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 25 Jun 2020 16:00:45 +0200 Subject: [PATCH 05/26] Update templates/CONTRIBUTING.md Co-authored-by: Thomas Payet --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 29c768b..4ba3703 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -22,7 +22,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ## 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 [docs](https://docs.meilisearch.com) and the [README](/README.md).** +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 From 22fd2d073d202e571e698660b106842c32702a26 Mon Sep 17 00:00:00 2001 From: Clementine Urquizar Date: Thu, 25 Jun 2020 16:03:14 +0200 Subject: [PATCH 06/26] Add final words --- templates/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 4ba3703..b508673 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -127,3 +127,5 @@ Some points about GitHub PR: - 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/XXX/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 ❤️ From a75e295418d37fe6c8fc9bd5c9c17859c097e6d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 25 Jun 2020 16:06:20 +0200 Subject: [PATCH 07/26] Update templates/CONTRIBUTING.md --- templates/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index b508673..6b1c413 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -122,7 +122,8 @@ We don't follow any other convention, but if you want to use one, we recommend [ ### GitHub Pull Requests Some points about GitHub PR: -- [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. +- [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. - All PRs must be reviewed and approved by at least one maintainer. - All PRs have to be **squashed and merged**. From 58fbcd19d2f3460b0a7010939608204bfd4ccab2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 09:29:27 +0200 Subject: [PATCH 08/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 6b1c413..5a591f1 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -27,7 +27,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ## How to Contribute -1. Ensure your change has an issue! Find an [existing issue](https://github.com/meilisearch/XXX/issues/) or [open a new issue](https://github.com/meilisearch/XXX/issues/new). This is where you can get a feel if the change will be accepted or not. +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/XXX/issues/) or [open a new one](https://github.com/meilisearch/XXX/issues/new). 2. Once approved, [fork the XXX repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. 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. From 01ec0924847a271595c97e29e6d22fc23fc93eb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 09:32:50 +0200 Subject: [PATCH 09/26] Update templates/CONTRIBUTING.md --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 5a591f1..0bb397c 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -32,7 +32,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume 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 XXX repo. A team member should comment and/or review your Pull Request with a few days. Although, depending on the circumstances, it may take longer.
+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 XXX repo. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
About the PR title, we do not adopt any type of naming style, but **please use something descriptive of your changes**. The title of the PR will be indeed automatically added to the next [release changlogs](https://github.com/meilisearch/XXX/releases/). ## Development Workflow From 85bf6a1ac18f85b4a2bc307f10559b42ee720938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 09:34:16 +0200 Subject: [PATCH 10/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 0bb397c..945b731 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -86,7 +86,7 @@ Some points about this automatization: - 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: set the label `skip-changelog`. We used to remove PRs updating the README or the CI (except for big changes). - If the changes you are doing in the PR are breaking: set 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 bad-named the title of your PR, don't panic: change what you want in the closed PR and run the job again. +- 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 [release drafter](https://github.com/release-drafter/release-drafter) we use to automatize these steps.* From f1c3bb9466daa43d1e01aed619666077caafa384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 09:35:19 +0200 Subject: [PATCH 11/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 945b731..6e63c6e 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -33,7 +33,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume 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 XXX repo. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
- About the PR title, we do not adopt any type of naming style, but **please use something descriptive of your changes**. The title of the PR will be indeed automatically added to the next [release changlogs](https://github.com/meilisearch/XXX/releases/). + 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 changlogs](https://github.com/meilisearch/XXX/releases/). ## Development Workflow From 4898cce69e15cc2055c8ccf1110469f837c068b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 09:35:47 +0200 Subject: [PATCH 12/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 6e63c6e..222a695 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -107,7 +107,7 @@ A GitHub Action will be triggered and push the package on [\ Date: Mon, 29 Jun 2020 09:36:09 +0200 Subject: [PATCH 13/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 222a695..08a0923 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -111,7 +111,7 @@ We do not enforce any branch naming style, but please use something descriptive ### Git Commits -As a minimal requirement, we ask the commit message: +As minimal requirements, your commit message should be: - to be capitalized - not to finish by a dot or any other punctuation character (!,?) - to start with a verb so that we can read your commit message this way: "This commmit will ..." where "..." is the commit message. From 83311bfdbc55e041faf6fc15adc5db1e6a5ebac5 Mon Sep 17 00:00:00 2001 From: Clementine Urquizar Date: Mon, 29 Jun 2020 09:47:30 +0200 Subject: [PATCH 14/26] Remove empty line --- templates/CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 08a0923..81998df 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -75,7 +75,6 @@ $ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). - #### Automatiazed 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/XXX/releases). If you don't have the permission to this repository, you will not be able to see the draft release until the release will be published. From 04ef0fa34845b863bffa26a8c6246a1864309785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 10:34:20 +0200 Subject: [PATCH 15/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 81998df..e06669a 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -75,7 +75,7 @@ $ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). -#### Automatiazed Changelogs +#### 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/XXX/releases). If you don't have the permission to this repository, you will not be able to see the draft release until the release will be published. From 4be09454484b756d7b2783e8e48b961e79fba6f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 10:34:28 +0200 Subject: [PATCH 16/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index e06669a..4100306 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -81,7 +81,7 @@ For each PR merged on `master`, a GitHub Action is running and updates the next 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 desriptive of this change. -Some points about this automatization: +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: set the label `skip-changelog`. We used to remove PRs updating the README or the CI (except for big changes). - If the changes you are doing in the PR are breaking: set 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. From 69c1d6f3b4c7212390915ac16d27fab1c85987f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 10:34:36 +0200 Subject: [PATCH 17/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 4100306..7141229 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -87,7 +87,7 @@ About this automation: - If the changes you are doing in the PR are breaking: set 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 [release drafter](https://github.com/release-drafter/release-drafter) we use to automatize these steps.* +*More information about [release drafter](https://github.com/release-drafter/release-drafter), used to automate these steps.* #### How to Publish the Release From 1c254d86206649d572426774b55201075087a90c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 11:03:13 +0200 Subject: [PATCH 18/26] Update templates/CONTRIBUTING.md Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> --- templates/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 7141229..6e8123a 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -110,10 +110,10 @@ We do not enforce any branch naming style, but please use something descriptive ### Git Commits -As minimal requirements, your commit message should be: -- to be capitalized -- not to finish by a dot or any other punctuation character (!,?) -- to start with a verb so that we can read your commit message this way: "This commmit will ..." where "..." is the commit message. +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 commmit 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/). From adf9d1d72aec2c65eadbbc13ef23a2d66261f7d9 Mon Sep 17 00:00:00 2001 From: Clementine Urquizar Date: Mon, 29 Jun 2020 13:50:47 +0200 Subject: [PATCH 19/26] Change step 2 in How To Contribute --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 6e8123a..6c36e84 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -28,7 +28,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ## 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/XXX/issues/) or [open a new one](https://github.com/meilisearch/XXX/issues/new). -2. Once approved, [fork the XXX repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. +2. Once done, [fork the XXX 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. From 1a23bbe5969c90a3d30a4f4c812b7645784f16d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 13:55:07 +0200 Subject: [PATCH 20/26] Update templates/CONTRIBUTING.md --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 6c36e84..f2f8e0b 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -77,7 +77,7 @@ 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/XXX/releases). If you don't have the permission to this repository, you will not be able to see the draft release until the release will be published. +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/XXX/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 desriptive of this change. From c587869412d7ed3266d9bf6f118a6af133d16447 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 14:12:35 +0200 Subject: [PATCH 21/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index f2f8e0b..4a750c9 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -33,7 +33,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume 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 XXX repo. 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 changlogs](https://github.com/meilisearch/XXX/releases/). + 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/XXX/releases/). ## Development Workflow From 8c1b959de65b9e21a7021921cce02a4f7aeb509a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 14:14:11 +0200 Subject: [PATCH 22/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 4a750c9..87d9833 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -83,7 +83,7 @@ The draft release description is therefore generated and corresponds to all the 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: set the label `skip-changelog`. We used to remove PRs updating the README or the CI (except for big changes). +- 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: set 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. From 9b2953dddf94eb721256256b1be642eb1e70d574 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 14:14:20 +0200 Subject: [PATCH 23/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 87d9833..b3d3dba 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -84,7 +84,7 @@ The draft release description is therefore generated and corresponds to all the 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: set 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 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 [release drafter](https://github.com/release-drafter/release-drafter), used to automate these steps.* From 19db6c9df93f4d58411850478f4c72c30225f904 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 14:14:28 +0200 Subject: [PATCH 24/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index b3d3dba..5905ac2 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -113,7 +113,7 @@ We do not enforce any branch naming style, but please use something descriptive 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 commmit will ..." where "..." is the commit message. +- start with a verb so that we can read your commit message this way: "This commmit 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/). From abe9f17ce73c28b54ec698e92ca12eb419d9c663 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 14:14:35 +0200 Subject: [PATCH 25/26] Update templates/CONTRIBUTING.md Co-authored-by: Samuel Jimenez --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 5905ac2..a7a1b92 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -120,7 +120,7 @@ We don't follow any other convention, but if you want to use one, we recommend [ ### GitHub Pull Requests -Some points about GitHub PR: +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. From 450e7335cfa80c6b2ce42892eac5ee3b08390973 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 29 Jun 2020 15:10:21 +0200 Subject: [PATCH 26/26] Update templates/CONTRIBUTING.md Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> --- templates/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index a7a1b92..14f8032 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -91,7 +91,7 @@ About this automation: #### How to Publish the Release -You must do a PR modifying the file `[]`(\) with the right version. +Make a PR modifying the file `[]`(\) with the right version. ```