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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-16Lines changed: 5 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,12 @@
2
2
3
3
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.
4
4
5
-
-[Hacktoberfest](#hacktoberfest)
6
5
-[Assumptions](#assumptions)
7
6
-[How to Contribute](#how-to-contribute)
8
7
-[Development Workflow](#development-workflow)
9
8
-[Git Guidelines](#git-guidelines)
10
9
-[Release Process (for internal team only)](#release-process-for-internal-team-only)
🚀 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
-
22
11
## Assumptions
23
12
24
13
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:
103
92
104
93
-[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>
105
94
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.
107
96
- All PRs must be reviewed and approved by at least one maintainer.
108
97
- 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/).
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
115
104
116
105
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)._
118
107
119
108
### Automated Changelogs <!-- omit in toc -->
120
109
121
110
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)._
123
112
124
113
### How to Publish the Release <!-- omit in toc -->
125
114
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).
127
116
128
117
Make a PR modifying the file [`setup.py`](/setup.py) with the right version.
129
118
130
119
```python
131
120
version="X.X.X"
132
121
```
133
122
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`.
135
124
136
125
GitHub Actions will be triggered and push the package to [PyPI](https://pypi.org/project/meilisearch).
0 commit comments