Skip to content

Commit 473198d

Browse files
bors[bot]meili-bot
andauthored
Merge #195
195: 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 55be926 + 32e4ba8 commit 473198d

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

8787
- [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>
8888
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
89-
- 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.
89+
- 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.
9090
- All PRs must be reviewed and approved by at least one maintainer.
9191
- 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/vuepress-plugin-meilisearch/releases/).
9292

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

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

102102
### Automated Changelogs <!-- omit in TOC -->
103103

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

107107
### How to Publish the Release <!-- omit in TOC -->
108108

109-
⚠️ 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).
109+
⚠️ 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).
110110

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

113113
```javascript
114114
"version": "X.X.X"
115115
```
116116

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

119119
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/vuepress-plugin-meilisearch).
120120

0 commit comments

Comments
 (0)