Skip to content

Commit 4caafa2

Browse files
authored
Change master into main (#258)
1 parent 5fbb242 commit 4caafa2

File tree

4 files changed

+21
-25
lines changed

4 files changed

+21
-25
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/test.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
tests:

CONTRIBUTING.md

Lines changed: 16 additions & 20 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,18 +21,18 @@ 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 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>
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 changelog](https://github.com/meilisearch/instant-meilisearch/releases/).
3026

3127
## Development Workflow
3228

33-
### Setup
29+
### Setup <!-- omit in TOC -->
3430

3531
```bash
3632
$ yarn --dev
3733
```
3834

39-
### Tests and Linter
35+
### Tests and Linter <!-- omit in TOC -->
4036

4137
Each PR should pass the tests and the linter to be accepted.
4238

@@ -55,7 +51,7 @@ $ yarn lint:fix
5551
$ yarn build
5652
```
5753

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

6056
To test directly your changes in `instant-meilisearch`, you can run the Vue playground:
6157

@@ -81,12 +77,12 @@ $ yarn playground:html
8177

8278
## Git Guidelines
8379

84-
### Git Branches
80+
### Git Branches <!-- omit in TOC -->
8581

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

89-
### Git Commits
85+
### Git Commits <!-- omit in TOC -->
9086

9187
As minimal requirements, your commit message should:
9288
- be capitalized
@@ -96,41 +92,41 @@ As minimal requirements, your commit message should:
9692

9793
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/).
9894

99-
### GitHub Pull Requests
95+
### GitHub Pull Requests <!-- omit in TOC -->
10096

10197
Some notes on GitHub PRs:
10298

10399
- [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>
104100
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..
106102
- All PRs must be reviewed and approved by at least one maintainer.
107103
- 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/).
108104

109105
## Release Process (for internal team only)
110106

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

113-
### Automation to Rebase and Merge the PRs
109+
### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
114110

115111
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)._
117113

118-
### Automated Changelogs
114+
### Automated Changelogs <!-- omit in TOC -->
119115

120116
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)._
122118

123-
### How to Publish the Release
119+
### How to Publish the Release <!-- omit in TOC -->
124120

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

127123
Make a PR modifying the file [`package.json`](/package.json) with the right version.
128124

129125
```javascript
130126
"version": "X.X.X"
131127
```
132128

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

135131
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
136132

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/master/assets/logos/logo.svg" alt="Instant-MeiliSearch" width="200" height="200" />
2+
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/logo.svg" alt="Instant-MeiliSearch" width="200" height="200" />
33
</p>
44

55
<h1 align="center">Instant MeiliSearch</h1>
@@ -15,8 +15,8 @@
1515

1616
<p align="center">
1717
<a href="https://www.npmjs.com/package/@meilisearch/instant-meilisearch"><img src="https://img.shields.io/npm/v/@meilisearch/instant-meilisearch.svg" alt="npm version"></a>
18-
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=master" alt="Tests"></a>
19-
<a href="https://github.com/meilisearch/instant-meilisearch/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
18+
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
19+
<a href="https://github.com/meilisearch/instant-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
2020
<a href="https://github.com/meilisearch/MeiliSearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
2121
<a href="https://app.bors.tech/repositories/28908"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2222
</p>

0 commit comments

Comments
 (0)