Issue #1321
closed
Commit message requirements for Pulp contributions are out of date and could be better
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
Updated by bmbouter about 9 years ago
- Blocked by Task #103: Document the commit message keywords that will interact with Redmine added
Added by daviddavis about 8 years ago
Added by daviddavis about 8 years ago
Revision 292b8904 | View on GitHub
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
Updated by daviddavis about 8 years ago
- Related to Task #2426: Update our Pulp 3.0 documentation with git commit message info added
Updated by daviddavis about 8 years ago
- Status changed from NEW to MODIFIED
Applied in changeset pulp|292b8904f3476c12020fe631c7fb0ca0971aa757.
Updated by semyers about 8 years ago
- Platform Release set to 2.12.0
Updated by semyers almost 8 years ago
- Status changed from 5 to CLOSED - CURRENTRELEASE
.
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