Skip to content

Commit 741be90

Browse files
authored
Change master into main (#97)
1 parent de09dcf commit 741be90

File tree

4 files changed

+18
-22
lines changed

4 files changed

+18
-22
lines changed

.github/workflows/release-drafter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Release Drafter
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77

88
jobs:
99
update_release_draft:

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
branches:
88
- trying
99
- staging
10-
- master
10+
- main
1111

1212
jobs:
1313
linter:

CONTRIBUTING.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
# Contributing
1+
# Contributing <!-- omit in TOC -->
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-
<!-- MarkdownTOC autolink="true" style="ordered" indent=" " -->
6-
75
- [Assumptions](#assumptions)
86
- [How to Contribute](#how-to-contribute)
97
- [Development Workflow](#development-workflow)
108
- [Git Guidelines](#git-guidelines)
119
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
1210

13-
<!-- /MarkdownTOC -->
14-
1511
## Assumptions
1612

1713
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
2521
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).
2622
4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
2723
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>
2925
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/).
3026

3127
## Development Workflow
3228

33-
### Install and Launch
29+
### Install and Launch <!-- omit in TOC -->
3430

3531
The [`pipenv` command](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) must be installed.
3632

@@ -43,7 +39,7 @@ $ pipenv install
4339
$ pipenv run ./docs_scraper <path-to-your-config-file>
4440
```
4541

46-
### Linter and Tests
42+
### Linter and Tests <!-- omit in TOC -->
4743

4844
```bash
4945
$ pipenv install --dev
@@ -55,12 +51,12 @@ $ pipenv run pytest ./scraper/src -k "not _browser"
5551

5652
## Git Guidelines
5753

58-
### Git Branches
54+
### Git Branches <!-- omit in TOC -->
5955

6056
All changes must be made in a branch and submitted as PR.
6157
We do not enforce any branch naming style, but please use something descriptive of your changes.
6258

63-
### Git Commits
59+
### Git Commits <!-- omit in TOC -->
6460

6561
As minimal requirements, your commit message should:
6662
- be capitalized
@@ -70,35 +66,35 @@ As minimal requirements, your commit message should:
7066

7167
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/).
7268

73-
### GitHub Pull Requests
69+
### GitHub Pull Requests <!-- omit in TOC -->
7470

7571
Some notes on GitHub PRs:
7672

7773
- [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>
7874
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..
8076
- All PRs must be reviewed and approved by at least one maintainer.
8177
- 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/).
8278

8379
## Release Process (for internal team only)
8480

8581
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
8682

87-
### Automation to Rebase and Merge the PRs
83+
### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
8884

8985
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)._
9187

92-
### Automated Changelogs
88+
### Automated Changelogs <!-- omit in TOC -->
9389

9490
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)._
9692

97-
### How to Publish the Release
93+
### How to Publish the Release <!-- omit in TOC -->
9894

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).
10096

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).
10298

10399
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).
104100

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
<p align="center">
1717
<a href="https://github.com/meilisearch/docs-scraper/actions"><img src="https://github.com/meilisearch/docs-scraper/workflows/Tests/badge.svg" alt="GitHub Workflow Status"></a>
18-
<a href="https://github.com/meilisearch/docs-scraper/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
18+
<a href="https://github.com/meilisearch/docs-scraper/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
1919
<a href="https://app.bors.tech/repositories/28977"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2020
</p>
2121

0 commit comments

Comments
 (0)