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
+16-20Lines changed: 16 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,13 @@
1
-
# Contributing
1
+
# Contributing<!-- omit in TOC -->
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.
-[Release Process (for internal team only)](#release-process-for-internal-team-only)
12
10
13
-
<!-- /MarkdownTOC -->
14
-
15
11
## Assumptions
16
12
17
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.**
@@ -25,18 +21,18 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
25
21
3.[Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
26
22
4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
27
23
5. Make the changes on your branch.
28
-
6.[Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `master` branch of the main instant-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
24
+
6.[Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main instant-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
29
25
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/instant-meilisearch/releases/).
30
26
31
27
## Development Workflow
32
28
33
-
### Setup
29
+
### Setup<!-- omit in TOC -->
34
30
35
31
```bash
36
32
$ yarn --dev
37
33
```
38
34
39
-
### Tests and Linter
35
+
### Tests and Linter<!-- omit in TOC -->
40
36
41
37
Each PR should pass the tests and the linter to be accepted.
42
38
@@ -55,7 +51,7 @@ $ yarn lint:fix
55
51
$ yarn build
56
52
```
57
53
58
-
### Playgrounds
54
+
### Playgrounds<!-- omit in TOC -->
59
55
60
56
To test directly your changes in `instant-meilisearch`, you can run the Vue playground:
61
57
@@ -81,12 +77,12 @@ $ yarn playground:html
81
77
82
78
## Git Guidelines
83
79
84
-
### Git Branches
80
+
### Git Branches<!-- omit in TOC -->
85
81
86
82
All changes must be made in a branch and submitted as PR.
87
83
We do not enforce any branch naming style, but please use something descriptive of your changes.
88
84
89
-
### Git Commits
85
+
### Git Commits<!-- omit in TOC -->
90
86
91
87
As minimal requirements, your commit message should:
92
88
- be capitalized
@@ -96,41 +92,41 @@ As minimal requirements, your commit message should:
96
92
97
93
We don't follow any other convention, but if you want to use one, we recommend [this one](https://chris.beams.io/posts/git-commit/).
98
94
99
-
### GitHub Pull Requests
95
+
### GitHub Pull Requests<!-- omit in TOC -->
100
96
101
97
Some notes on GitHub PRs:
102
98
103
99
-[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>
104
100
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
105
-
- The branch related to the PR must be **up-to-date with `master`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually..
101
+
- 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..
106
102
- All PRs must be reviewed and approved by at least one maintainer.
107
103
- 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/).
108
104
109
105
## Release Process (for internal team only)
110
106
111
107
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
112
108
113
-
### Automation to Rebase and Merge the PRs
109
+
### Automation to Rebase and Merge the PRs<!-- omit in TOC -->
114
110
115
111
This project integrates a bot that helps us manage pull requests merging.<br>
116
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md)._
112
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
117
113
118
-
### Automated Changelogs
114
+
### Automated Changelogs<!-- omit in TOC -->
119
115
120
116
This project integrates a tool to create automated changelogs.<br>
121
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/release-drafter.md)._
117
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
122
118
123
-
### How to Publish the Release
119
+
### How to Publish the Release<!-- omit in TOC -->
124
120
125
-
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration Tool](https://github.com/meilisearch/integration-guides/blob/master/guides/integration-tool-release.md).
121
+
⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration Tool](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-tool-release.md).
126
122
127
123
Make a PR modifying the file [`package.json`](/package.json) with the right version.
128
124
129
125
```javascript
130
126
"version":"X.X.X"
131
127
```
132
128
133
-
Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases).
129
+
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).
134
130
135
131
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
0 commit comments