Skip to content

Commit d26d509

Browse files
bors[bot]meili-bot
andauthored
Merge #208
208: Fix links and improve CONTRIBUTING.md r=curquiza a=meili-bot _This PR is auto-generated._ Fix links in CONTRIBUTING.md and add some information related to the release Co-authored-by: meili-bot <[email protected]>
2 parents 2e6759f + 7c97d70 commit d26d509

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Some notes on GitHub PRs:
116116

117117
- [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>
118118
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
119-
- 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.
119+
- 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/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
120120
- All PRs must be reviewed and approved by at least one maintainer.
121121
- 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/).
122122

@@ -127,16 +127,16 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
127127
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
128128

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

132132
### Automated Changelogs <!-- omit in toc -->
133133

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

137137
### How to Publish the Release <!-- omit in toc -->
138138

139-
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-release.md).
139+
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
140140

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

@@ -164,7 +164,7 @@ Also, you might need to change the [code-samples file](/.code-samples.meilisearc
164164
meilisearch-sdk = "X.X"
165165
```
166166

167-
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).
167+
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): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
168168

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

0 commit comments

Comments
 (0)