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
594: 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]>
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
@@ -117,7 +117,7 @@ Some notes on GitHub PRs:
117
117
118
118
-[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>
119
119
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
120
-
- 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.
120
+
- 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.
121
121
- All PRs must be reviewed and approved by at least one maintainer.
122
122
- 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/instant-meilisearch/releases/).
### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
129
129
130
130
This project integrates a bot that helps us manage pull requests merging.<br>
131
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
131
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
132
132
133
133
### Automated Changelogs <!-- omit in TOC -->
134
134
135
135
This project integrates a tool to create automated changelogs.<br>
136
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
136
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
137
137
138
138
### How to Publish the Release <!-- omit in TOC -->
139
139
140
-
⚠️ 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).
140
+
⚠️ 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).
141
141
142
142
Make a PR modifying the file [`package.json`](/package.json) with the right version.
143
143
144
144
```javascript
145
145
"version":"X.X.X"
146
146
```
147
147
148
-
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases).
148
+
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/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`.
149
149
150
150
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
0 commit comments