Project

Profile

Help

Issue #1321

closed

Commit message requirements for Pulp contributions are out of date and could be better

Added by bmbouter over 8 years ago. Updated about 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
-
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

Related to Pulp - Task #2426: Update our Pulp 3.0 documentation with git commit message infoCLOSED - CURRENTRELEASEdaviddavis

Actions
Blocked by Pulp - Task #103: Document the commit message keywords that will interact with RedmineCLOSED - CURRENTRELEASEdaviddavis

Actions

Also available in: Atom PDF