Skip to content

Commit 8a3916d

Browse files
committed
Merge branch 'main' into bump-meilisearch-v0.24.0
2 parents 1b6f674 + fa05667 commit 8a3916d

File tree

2 files changed

+102
-47
lines changed

2 files changed

+102
-47
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,12 @@
22

33
First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
44

5-
- [Hacktoberfest](#hacktoberfest)
65
- [Assumptions](#assumptions)
76
- [How to Contribute](#how-to-contribute)
87
- [Development Workflow](#development-workflow)
98
- [Git Guidelines](#git-guidelines)
109
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
1110

12-
## Hacktoberfest
13-
14-
It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest-2021/)! 🥳
15-
16-
🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!
17-
18-
✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberfest-accepted` label.
19-
20-
🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards)! Low-quality PRs might get marked as `spam` or `invalid`, and will not count toward your participation in Hacktoberfest.
21-
2211
## Assumptions
2312

2413
1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
@@ -103,7 +92,7 @@ Some notes on GitHub PRs:
10392

10493
- [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>
10594
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
106-
- 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.
95+
- 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.
10796
- All PRs must be reviewed and approved by at least one maintainer.
10897
- 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-python/releases/).
10998

@@ -114,24 +103,24 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
114103
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
115104

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

119108
### Automated Changelogs <!-- omit in toc -->
120109

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

124113
### How to Publish the Release <!-- omit in toc -->
125114

126-
⚠️ 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).
115+
⚠️ 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).
127116

128117
Make a PR modifying the file [`setup.py`](/setup.py) with the right version.
129118

130119
```python
131120
version="X.X.X"
132121
```
133122

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

136125
GitHub Actions will be triggered and push the package to [PyPI](https://pypi.org/project/meilisearch).
137126

0 commit comments

Comments
 (0)