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
+15-19Lines changed: 15 additions & 19 deletions
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,12 +21,12 @@ 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 docs-scraper 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 docs-scraper 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 changelogs](https://github.com/meilisearch/docs-scraper/releases/).
30
26
31
27
## Development Workflow
32
28
33
-
### Install and Launch
29
+
### Install and Launch<!-- omit in TOC -->
34
30
35
31
The [`pipenv` command](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) must be installed.
36
32
@@ -43,7 +39,7 @@ $ pipenv install
43
39
$ pipenv run ./docs_scraper <path-to-your-config-file>
All changes must be made in a branch and submitted as PR.
61
57
We do not enforce any branch naming style, but please use something descriptive of your changes.
62
58
63
-
### Git Commits
59
+
### Git Commits<!-- omit in TOC -->
64
60
65
61
As minimal requirements, your commit message should:
66
62
- be capitalized
@@ -70,35 +66,35 @@ As minimal requirements, your commit message should:
70
66
71
67
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/).
72
68
73
-
### GitHub Pull Requests
69
+
### GitHub Pull Requests<!-- omit in TOC -->
74
70
75
71
Some notes on GitHub PRs:
76
72
77
73
-[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>
78
74
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
79
-
- 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..
75
+
- 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..
80
76
- All PRs must be reviewed and approved by at least one maintainer.
81
77
- 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/docs-scraper/releases/).
82
78
83
79
## Release Process (for internal team only)
84
80
85
81
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
86
82
87
-
### Automation to Rebase and Merge the PRs
83
+
### Automation to Rebase and Merge the PRs<!-- omit in TOC -->
88
84
89
85
This project integrates a bot that helps us manage pull requests merging.<br>
90
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/bors.md)._
86
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
91
87
92
-
### Automated Changelogs
88
+
### Automated Changelogs<!-- omit in TOC -->
93
89
94
90
This project integrates a tool to create automated changelogs.<br>
95
-
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/master/guides/release-drafter.md)._
91
+
_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
96
92
97
-
### How to Publish the Release
93
+
### How to Publish the Release<!-- omit in TOC -->
98
94
99
-
⚠️ 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).
95
+
⚠️ 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).
100
96
101
-
Once the changes are merged on `master`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/docs-scraper/releases).
97
+
Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/docs-scraper/releases).
102
98
103
99
GitHub Actions will be triggered and push the `latest` and `vX.X.X` version of the Docker image to [DockerHub](https://hub.docker.com/repository/docker/getmeili/docs-scraper).
0 commit comments