Skip to content

Commit 759172c

Browse files
chore: Update MAINTAINING.md (#813)
1 parent 44b6d7d commit 759172c

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

other/MAINTAINING.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Maintaining
22

3+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
4+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
5+
6+
**Table of Contents**
7+
8+
- [Code of Conduct](#code-of-conduct)
9+
- [Issues](#issues)
10+
- [Pull Requests](#pull-requests)
11+
- [Release](#release)
12+
- [Thanks!](#thanks)
13+
14+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
15+
316
This is documentation for maintainers of this project.
417

518
## Code of Conduct
@@ -32,9 +45,9 @@ any more of you than that.
3245
As a maintainer, you're fine to make your branches on the main repo or on your
3346
own fork. Either way is fine.
3447

35-
When we receive a pull request, a github action is kicked off automatically (see
36-
the `.github/workflows/validate.yml` for what runs in the action). We avoid
37-
merging anything that breaks the github action.
48+
When we receive a pull request, a GitHub Action is kicked off automatically (see
49+
the `.github/workflows/validate.yml` for what runs in the Action). We avoid
50+
merging anything that breaks the GitHub Action.
3851

3952
Please review PRs and focus on the code rather than the individual. You never
4053
know when this is someone's first ever PR and we want their experience to be as
@@ -49,7 +62,7 @@ to release. See the next section on Releases for more about that.
4962
## Release
5063

5164
Our releases are automatic. They happen whenever code lands into `master`. A
52-
github action gets kicked off and if it's successful, a tool called
65+
GitHub Action gets kicked off and if it's successful, a tool called
5366
[`semantic-release`](https://github.com/semantic-release/semantic-release) is
5467
used to automatically publish a new release to npm as well as a changelog to
5568
GitHub. It is only able to determine the version and whether a release is
@@ -66,5 +79,6 @@ necessary by the git commit messages. With this in mind, **please brush up on
6679

6780
Thank you so much for helping to maintain this project!
6881

69-
[commit]:
70-
https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
82+
<!-- prettier-ignore-start -->
83+
[commit]: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
84+
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)