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