Skip to content

Commit 47a5d25

Browse files
authored
Update CONTRIBUTING.md notes
[skip ci] Signed-off-by: ascopes <73482956+ascopes@users.noreply.github.com>
1 parent 29c6956 commit 47a5d25

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,24 @@ ignored.
4141
## Getting help
4242

4343
Please make a discussion in the discussions tab rather
44-
than opening a new issue if you need help with something!
44+
than opening a new issue if you need help with using this library.
4545

4646
## Contributing changes to fix issues
4747

4848
If you are contributing to an issue, drop a message on
49-
that issue so that I can assign it to you! If you would be
49+
that issue so that I can assign it to you! **If you would be
5050
able to keep me up to date with any progress on that issue,
51-
that would be fantastic, since it enables me to track
51+
that would be fantastic**, since it enables me to track
5252
how much work is left to do and to be able to provide any
5353
help if needed.
5454

55+
Everyone is entitled to their own life, but if I haven't heard anything back for a while,
56+
then I may unassign issues at my own discretion so that it can be worked on. If there is any
57+
reason you may not be able to do something for a while, then just let me know.
58+
59+
This is just so I can keep track of what is being worked on without changes being proposed
60+
but never actually finished.
61+
5562
## Branching
5663

5764
When you are ready, make a fork of this repo. When you
@@ -127,3 +134,19 @@ Please try to keep commits atomic and clear. Each commit
127134
should ideally leave the project in a working state. Each
128135
commit should also have a clear title and explaination as
129136
to what the commit changes, and why.
137+
138+
## Deployment process
139+
140+
Deployments to Maven Central are performed from GitHub Actions, and are triggered when we feel
141+
that it is an appropriate time to release a change.
142+
143+
Unless otherwise specified, deployments will occur from the `main` branch, so any PRs should
144+
target that branch where possible.
145+
146+
Changelogs are automatically generated from the pull request history between the head of the
147+
`main` branch and the last tag that was added. This is why it is important to have descriptive
148+
pull requests where appropriate.
149+
150+
Upon successfully deploying to Maven Central, a release will be added to the
151+
[releases](../../releases) page on the repository. A changelog will automatically get
152+
attached and any contributors will be `@mentioned` in those changelogs.

0 commit comments

Comments
 (0)