From a62265224a78297589a29d60676086cd3ea6a78c Mon Sep 17 00:00:00 2001 From: Tobias Roeser Date: Mon, 24 Oct 2022 13:01:20 +0200 Subject: [PATCH] Started to draft some maintenance docs --- readme.adoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/readme.adoc b/readme.adoc index 7666e270f13..2d4281c04d5 100644 --- a/readme.adoc +++ b/readme.adoc @@ -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: ` +* 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: ` +* If the message contains links to other issues or pull requests, you should use full URLs to reference them + == Changelog