Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Started to draft some maintenance docs #2084

Merged
merged 1 commit into from
Oct 25, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,23 @@ These are maintained as part of the primary Mill Github repo for easy testing/up
APIs evolve, ensuring that they are always tested and passing against the
corresponding version of Mill.

== Project Maintenance

=== Pull Requests

* Changes to the main branch need a pull request. Exceptions are preparation commits for releases, which are meant to be pushed with tags in one go
* Merged pull request (and closed issues) need to be assigned to a Milestone
* Pull requests are typically merged via "Squash and merge", so we get a linear and useful history
* Larger pull request, where it makes sense to keep single commits, or with multiple authors may be committed via merge commits.

=== Commit Messages

* The title should be meaningful and may contain the pull request number in parentheses (typically automatically generated on GitHub)
* The description should contain additional required details, which typically reflect the content of the first PR comment
* A full link to the pull request should be added via a line: `Pull request: <link>`
* If the PR has multiple authors but is merged as merge commit, those authors should be included via a line for each co-author: `Co-authored-by: <author>`
* If the message contains links to other issues or pull requests, you should use full URLs to reference them

== Changelog


Expand Down