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