Skip to content

Commit fc85727

Browse files
committed
Update CONTRIBUTING.md
1 parent 39c4c42 commit fc85727

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
2525
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).
2626
4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
2727
5. Make the changes on your branch.
28-
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.<br>
28+
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 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.<br>
2929
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/).
3030

3131
## Development Workflow
@@ -112,7 +112,7 @@ Some notes on GitHub PRs:
112112

113113
- [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>
114114
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
115-
- 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..
115+
- 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..
116116
- All PRs must be reviewed and approved by at least one maintainer.
117117
- 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/meilisearch-rust/releases/).
118118

@@ -123,16 +123,16 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
123123
### Automation to Rebase and Merge the PRs
124124

125125
This project integrates a bot that helps us manage pull requests merging.<br>
126-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md)._
126+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
127127

128128
### Automated Changelogs
129129

130130
This project integrates a tool to create automated changelogs.<br>
131-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/release-drafter.md)._
131+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
132132

133133
### How to Publish the Release
134134

135-
⚠️ 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).
135+
⚠️ 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).
136136

137137
Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
138138

@@ -160,7 +160,7 @@ Also, you might need to change the [code-samples file](/.code-samples.meilisearc
160160
meilisearch-sdk = "X.X"
161161
```
162162

163-
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).
163+
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-rust/releases).
164164

165165
GitHub Actions will be triggered and push the package to [crates.io](https://crates.io/crates/meilisearch-sdk).
166166

0 commit comments

Comments
 (0)