Skip to content

Commit a81536c

Browse files
bors[bot]meili-bot
andauthored
Merge #594
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]>
2 parents f2911ed + dd6e2c7 commit a81536c

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
@@ -117,7 +117,7 @@ Some notes on GitHub PRs:
117117

118118
- [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>
119119
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.
121121
- All PRs must be reviewed and approved by at least one maintainer.
122122
- 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/).
123123

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

130130
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)._
132132

133133
### Automated Changelogs <!-- omit in TOC -->
134134

135135
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)._
137137

138138
### How to Publish the Release <!-- omit in TOC -->
139139

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).
141141

142142
Make a PR modifying the file [`package.json`](/package.json) with the right version.
143143

144144
```javascript
145145
"version": "X.X.X"
146146
```
147147

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`.
149149

150150
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
151151

0 commit comments

Comments
 (0)