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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ Some notes on GitHub PRs:
116
116
117
117
-[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>
118
118
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.
120
120
- All PRs must be reviewed and approved by at least one maintainer.
121
121
- 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/).
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
128
128
129
129
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)._
131
131
132
132
### Automated Changelogs <!-- omit in toc -->
133
133
134
134
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)._
136
136
137
137
### How to Publish the Release <!-- omit in toc -->
138
138
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).
140
140
141
141
Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
142
142
@@ -164,7 +164,7 @@ Also, you might need to change the [code-samples file](/.code-samples.meilisearc
164
164
meilisearch-sdk = "X.X"
165
165
```
166
166
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`.
168
168
169
169
GitHub Actions will be triggered and push the package to [crates.io](https://crates.io/crates/meilisearch-sdk).
0 commit comments