@@ -4,60 +4,67 @@ This is documentation for maintainers of this project.
4
4
5
5
## Code of Conduct
6
6
7
- Please review, understand, and be an example of it. Violations of the code of conduct are
8
- taken seriously, even (especially) for maintainers.
7
+ Please review, understand, and be an example of it. Violations of the code of
8
+ conduct are taken seriously, even (especially) for maintainers.
9
9
10
10
## Issues
11
11
12
- We want to support and build the community. We do that best by helping people learn to solve
13
- their own problems. We have an issue template and hopefully most folks follow it. If it's
14
- not clear what the issue is, invite them to create a minimal reproduction of what they're trying
15
- to accomplish or the bug they think they've found.
12
+ We want to support and build the community. We do that best by helping people
13
+ learn to solve their own problems. We have an issue template and hopefully most
14
+ folks follow it. If it's not clear what the issue is, invite them to create a
15
+ minimal reproduction of what they're trying to accomplish or the bug they think
16
+ they've found.
16
17
17
18
Once it's determined that a code change is necessary, point people to
18
- [ makeapullrequest.com] ( http://makeapullrequest.com ) and invite them to make a pull request.
19
- If they're the one who needs the feature, they're the one who can build it. If they need
20
- some hand holding and you have time to lend a hand, please do so. It's an investment into
21
- another human being, and an investment into a potential maintainer.
19
+ [ makeapullrequest.com] ( http://makeapullrequest.com ) and invite them to make a
20
+ pull request. If they're the one who needs the feature, they're the one who can
21
+ build it. If they need some hand holding and you have time to lend a hand,
22
+ please do so. It's an investment into another human being, and an investment
23
+ into a potential maintainer.
22
24
23
- Remember that this is open source, so the code is not yours, it's ours. If someone needs a change
24
- in the codebase, you don't have to make it happen yourself. Commit as much time to the project
25
- as you want/need to. Nobody can ask any more of you than that.
25
+ Remember that this is open source, so the code is not yours, it's ours. If
26
+ someone needs a change in the codebase, you don't have to make it happen
27
+ yourself. Commit as much time to the project as you want/need to. Nobody can ask
28
+ any more of you than that.
26
29
27
30
## Pull Requests
28
31
29
- As a maintainer, you're fine to make your branches on the main repo or on your own fork. Either
30
- way is fine.
32
+ As a maintainer, you're fine to make your branches on the main repo or on your
33
+ own fork. Either way is fine.
31
34
32
- When we receive a pull request, a travis build is kicked off automatically (see the ` .travis.yml `
33
- for what runs in the travis build). We avoid merging anything that breaks the travis build.
35
+ When we receive a pull request, a travis build is kicked off automatically (see
36
+ the ` .travis.yml ` for what runs in the travis build). We avoid merging anything
37
+ that breaks the travis build.
34
38
35
- Please review PRs and focus on the code rather than the individual. You never know when this is
36
- someone's first ever PR and we want their experience to be as positive as possible, so be
37
- uplifting and constructive.
39
+ Please review PRs and focus on the code rather than the individual. You never
40
+ know when this is someone's first ever PR and we want their experience to be as
41
+ positive as possible, so be uplifting and constructive.
38
42
39
43
When you merge the pull request, 99% of the time you should use the
40
- [ Squash and merge] ( https://help.github.com/articles/merging-a-pull-request/ ) feature. This keeps
41
- our git history clean, but more importantly, this allows us to make any necessary changes to the
42
- commit message so we release what we want to release. See the next section on Releases for more
43
- about that.
44
+ [ Squash and merge] ( https://help.github.com/articles/merging-a-pull-request/ )
45
+ feature. This keeps our git history clean, but more importantly, this allows us
46
+ to make any necessary changes to the commit message so we release what we want
47
+ to release. See the next section on Releases for more about that.
44
48
45
49
## Release
46
50
47
- Our releases are automatic. They happen whenever code lands into ` master ` . A travis build gets
48
- kicked off and if it's successful, a tool called
49
- [ ` semantic-release ` ] ( https://github.com/semantic-release/semantic-release ) is used to
50
- automatically publish a new release to npm as well as a changelog to GitHub. It is only able to
51
- determine the version and whether a release is necessary by the git commit messages. With this
52
- in mind, ** please brush up on [ the commit message convention] [ commit ] which drives our releases.**
51
+ Our releases are automatic. They happen whenever code lands into ` master ` . A
52
+ travis build gets kicked off and if it's successful, a tool called
53
+ [ ` semantic-release ` ] ( https://github.com/semantic-release/semantic-release ) is
54
+ used to automatically publish a new release to npm as well as a changelog to
55
+ GitHub. It is only able to determine the version and whether a release is
56
+ necessary by the git commit messages. With this in mind, ** please brush up on
57
+ [ the commit message convention] [ commit ] which drives our releases.**
53
58
54
- > One important note about this: Please make sure that commit messages do NOT contain the words
55
- > "BREAKING CHANGE" in them unless we want to push a major version. I've been burned by this
56
- > more than once where someone will include "BREAKING CHANGE: None" and it will end up releasing
57
- > a new major version. Not a huge deal honestly, but kind of annoying...
59
+ > One important note about this: Please make sure that commit messages do NOT
60
+ > contain the words "BREAKING CHANGE" in them unless we want to push a major
61
+ > version. I've been burned by this more than once where someone will include
62
+ > "BREAKING CHANGE: None" and it will end up releasing a new major version. Not
63
+ > a huge deal honestly, but kind of annoying...
58
64
59
65
## Thanks!
60
66
61
67
Thank you so much for helping to maintain this project!
62
68
63
- [ commit ] : https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
69
+ [ commit] :
70
+ https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
0 commit comments