|
| 1 | +# Maintaining |
| 2 | + |
| 3 | +This is documentation for maintainers of this project. |
| 4 | + |
| 5 | +## Code of Conduct |
| 6 | + |
| 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 | + |
| 10 | +## Issues |
| 11 | + |
| 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. |
| 17 | + |
| 18 | +Once it's determined that a code change is necessary, point people to |
| 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. |
| 24 | + |
| 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. |
| 29 | + |
| 30 | +## Pull Requests |
| 31 | + |
| 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. |
| 34 | + |
| 35 | +When we receive a pull request, a various automated checks are kicked off |
| 36 | +automatically. We avoid merging anything that doesn't pass these checks. |
| 37 | + |
| 38 | +Please review PRs and focus on the code rather than the individual. You never |
| 39 | +know when this is someone's first ever PR and we want their experience to be as |
| 40 | +positive as possible, so be uplifting and constructive. |
| 41 | + |
| 42 | +When you merge the pull request, 99% of the time you should use the |
| 43 | +[Squash and merge](https://help.github.com/articles/merging-a-pull-request/) |
| 44 | +feature. This keeps our git history clean, but more importantly, this allows us |
| 45 | +to make any necessary changes to the commit message so we release what we want |
| 46 | +to release. See the next section on Releases for more about that. |
| 47 | + |
| 48 | +## Release |
| 49 | + |
| 50 | +Our releases are automatic. They happen whenever code lands into `master`. A |
| 51 | +netlify build gets kicked off, and when tagged a changelog is published on |
| 52 | +GitHub. The changelog is generated based on the git commit messages. With this |
| 53 | +in mind, **please brush up on [the commit message convention][commit] which |
| 54 | +drives our releases.** |
| 55 | + |
| 56 | +> One important note about this: Please make sure that commit messages do NOT |
| 57 | +> contain the words "BREAKING CHANGE" in them unless we want to push a major |
| 58 | +> version. I've been burned by this more than once where someone will include |
| 59 | +> "BREAKING CHANGE: None" and it will end up releasing a new major version. Not |
| 60 | +> a huge deal honestly, but kind of annoying... |
| 61 | +
|
| 62 | +## Thanks! |
| 63 | + |
| 64 | +Thank you so much for helping to maintain this project! |
| 65 | + |
| 66 | +[commit]: |
| 67 | + https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md |
0 commit comments