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
1088: 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
@@ -84,7 +84,7 @@ Some notes on GitHub PRs:
84
84
85
85
-[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>
86
86
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
87
-
- 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.
87
+
- 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.
88
88
- All PRs must be reviewed and approved by at least one maintainer.
89
89
- 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-js/releases/).
This project integrates a bot that helps us manage pull requests merging.<br>
98
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
98
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
99
99
100
100
### Automated Changelogs
101
101
102
102
This project integrates a tool to create automated changelogs.<br>
103
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
103
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
104
104
105
105
### How to Publish the Release
106
106
107
-
⚠️ 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).
107
+
⚠️ 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).
108
108
109
109
Make a PR modifying the file [`package.json`](/package.json) with the right version.
110
110
111
111
```javascript
112
112
"version":"X.X.X",
113
113
```
114
114
115
-
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-js/releases).
115
+
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-js/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`.
116
116
117
117
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/meilisearch).
0 commit comments