Unverified Commit bc34a604 authored by Jean-Christophe Fillion-Robin's avatar Jean-Christophe Fillion-Robin
Browse files

DOC: Document title convention for commits

parent c4d0bdb5
......@@ -20,6 +20,18 @@ where:
* `SHA{N}` are the first N characters of the last official commit associated with the branch.
What is the title convention for commits ?
------------------------------------------
There are few scenarios to consider:
| Commit status | Title convention |
|--|--|
| already integrated upstream | Amend the commit title to include `[Backport] This is the original title`
| being considider for upstream integration | Amend the commit title to include `[Backport PR-<NNN>] This is the original title` where `<NNN>` identifies the associated pull request being reviewed. |
| applies only to iMSTK | If the commit will not be considered for upstream integration, consider using the prefix `[iMSTK] This is the title` |
Are there exceptions to the branch naming convention ?
------------------------------------------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment