Actions
Issue #1321
closedCommit message requirements for Pulp contributions are out of date and could be better
Start date:
Due date:
Estimated time:
Severity:
1. Low
Version:
Platform Release:
2.12.0
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix, Pulp 2
Sprint:
Quarter:
Description
Currently we recommend the old-style "bug number - title" as the only requirement for the contents of a squashed commit message. This is out of date since we now use the commit keyword integration w/ Redmine (see #103). Also it should have a link to the issue/story; I've seen that a lot already by convention. We should also ask contributors to write a description of their commit as a paragraph style body. This is a common style I see across the Internet. See an example here.
The fix should describe things similar to how they are done here. And also refer the user to the commit keywords (see #103).
You probably need to update this section, and maybe some places on the merging page that reference "commit messages".
Related issues
Actions
Update the git commit message section
Update the git commit message section in the docs to include a note about the keywords for referencing a Redmine issue and add some info about what constitutes a good commit message.
closes #103, #1321 https://pulp.plan.io/issues/103 https://pulp.plan.io/issues/1321