You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
21
21
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).
22
22
4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
23
23
5. Make the changes on your branch.
24
-
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 vuepress-plugin-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
24
+
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 `main` branch of the main vuepress-plugin-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
25
25
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/vuepress-plugin-meilisearch/releases/).
26
26
27
27
## Development Workflow
@@ -78,7 +78,7 @@ Some notes on GitHub PRs:
78
78
79
79
-[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.<br>
80
80
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
81
-
- The branch related to the PR must be **up-to-date with `master`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually..
81
+
- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually..
82
82
- All PRs must be reviewed and approved by at least one maintainer.
83
83
- 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](https://github.com/meilisearch/vuepress-plugin-meilisearch/releases/).
### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
90
90
91
91
This project integrates a bot that helps us manage pull requests merging.<br>
92
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md)._
92
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
93
93
94
94
### Automated Changelogs <!-- omit in TOC -->
95
95
96
96
This project integrates a tool to create automated changelogs.<br>
97
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/release-drafter.md)._
97
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
98
98
99
99
### How to Publish the Release <!-- omit in TOC -->
100
100
101
-
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration Tool](https://github.com/meilisearch/integration-guides/blob/master/guides/integration-tool-release.md).
101
+
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration Tool](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-tool-release.md).
102
102
103
103
Make a PR modifying the file [`package.json`](/package.json) with the right version.
104
104
105
105
```javascript
106
106
"version":"X.X.X"
107
107
```
108
108
109
-
Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/vuepress-plugin-meilisearch/releases).
109
+
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/vuepress-plugin-meilisearch/releases).
110
110
111
111
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/vuepress-plugin-meilisearch).
0 commit comments