Skip to content

Commit e2d2a03

Browse files
authored
Merge pull request libgit2#5925 from Batchyx/batchyx/master-to-main-doc
docs: stop mentioning libgit2's "master" branch
2 parents 0d0150d + 9eeee00 commit e2d2a03

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ easily accessible permanent record of the conversation.
3535

3636
## Libgit2 Versions
3737

38-
The `master` branch is the main branch where development happens.
38+
The `main` branch is the main branch where development happens.
3939
Releases are tagged
4040
(e.g. [v0.21.0](https://github.com/libgit2/libgit2/releases/tag/v0.21.0) )
4141
and when a critical bug fix needs to be backported, it will be done on a
@@ -51,7 +51,7 @@ commit SHA
5151
Using [`git describe`](http://git-scm.com/docs/git-describe) is a
5252
great way to tell us what version you're working with.
5353

54-
If you're not running against the latest `master` branch version,
54+
If you're not running against the latest `main` branch version,
5555
please compile and test against that to avoid re-reporting an issue that's
5656
already been fixed.
5757

@@ -68,11 +68,11 @@ flow](https://guides.github.com/introduction/flow/index.html), where
6868
contributors fork the [libgit2 repository](https://github.com/libgit2/libgit2),
6969
make their changes on branch, and submit a
7070
[Pull Request](https://help.github.com/articles/using-pull-requests)
71-
(a.k.a. "PR"). Pull requests should usually be targeted at the `master`
71+
(a.k.a. "PR"). Pull requests should usually be targeted at the `main`
7272
branch.
7373

7474
Life will be a lot easier for you (and us) if you follow this pattern
75-
(i.e. fork, named branch, submit PR). If you use your fork's `master`
75+
(i.e. fork, named branch, submit PR). If you use your fork's `main`
7676
branch directly, things can get messy.
7777

7878
Please include a nice description of your changes when you submit your PR;

docs/release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Releasing the library
22

3-
We have three kinds of releases: "full" releases, maintenance releases and security releases. Full ones release the state of the `master` branch whereas maintenance releases provide bugfixes building on top of the currently released series. Security releases are also for the current series but only contain security fixes on top of the previous release.
3+
We have three kinds of releases: "full" releases, maintenance releases and security releases. Full ones release the state of the `main` branch whereas maintenance releases provide bugfixes building on top of the currently released series. Security releases are also for the current series but only contain security fixes on top of the previous release.
44

55
## Full release
66

@@ -40,7 +40,7 @@ followed by the three sections in the changelog. For release candidates we can a
4040

4141
During the freeze, and certainly after the first release candidate, any bindings the core team work with should be updated in order to discover any issues that might come up with the multitude of approaches to memory management, embedding or linking.
4242

43-
Create a branch `maint/v0.X` at the current state of `master` after you've created the tag. This will be used for maintenance releases and lets our dependents track the latest state of the series.
43+
Create a branch `maint/v0.X` at the current state of `main` after you've created the tag. This will be used for maintenance releases and lets our dependents track the latest state of the series.
4444

4545
## Maintenance release
4646

@@ -76,7 +76,7 @@ We use docurium to generate our documentation. It is a tool written in ruby whic
7676

7777
gem install docurium
7878

79-
and run it against our description file with the tip of master checked out.
79+
and run it against our description file with the tip of `main` checked out.
8080

8181
cm doc api.docurium
8282

0 commit comments

Comments
 (0)