diff options
| author | New Tobin Paradigm <email@mattatobin.com> | 2020-10-02 05:13:43 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-02 05:13:43 -0400 |
| commit | 15acac52b1f92410f9c0e46737dd5e8413eb6c46 (patch) | |
| tree | 71f7c6a9a2ac43e8fcd5f0d6e36ab3282f6db581 | |
| parent | 96736fce75cd32bb34d353e0210f8eb2aad0278e (diff) | |
| download | uxp-15acac52b1f92410f9c0e46737dd5e8413eb6c46.tar.gz | |
Update CONTRIBUTING.md
Revise Commit message style and add Follow-up form
| -rw-r--r-- | docs/CONTRIBUTING.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 9379ea45a6..031ddb9043 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -93,15 +93,20 @@ With rare exception, it is advisable to use the following style for commit messa This would directly apply to anyone making a pull request.
+Single commits are where issues can be reasonably resolved in a single commit.
- Single Commit: `Issue #xxx - Cited issue title or appropriate direct description of changes`
- *`Issue #1083 - Deprecate FUEL extension helper javascript library`*
-- Multi-Part Commits: `Issue #xxx - Part Number: Appropriate direct description of changes`
+
+Multi-part commits would be used for complex issues. However, an exception exists for multi-part commits where the issue is anticipated or ends up being long term such as "Stop using unified compilation of sources". In these instances the multi-part form is not required.
+- Multi-Part Form: `Issue #xxx - Part Number: Appropriate direct description of changes`
- *`Issue #492 - Part 1: Remove files`*
- *`Issue #492 - Part 2: Build system, Installer/Packaging`*
- *`Issue #492 - Part 3: nsUpdateService.js, updater.cpp, nsUpdateDriver.cpp`*
- *`Issue #492 - Part 4: Remove superfluous brackets in nsUpdateService.js and updater.cpp`*
-An exception exists for multi-part commits where the issue is anticipated or ends up being long term such as "Stop using unified compilation of sources". In these instances the multi-part form is not required.
+Occasionally a resolved (and shipped) issue requires further changes to fix bugs. However, If follow-ups are complex enough to be multi-part it should be considered a new issue.
+- Follow-up Form: *`Issue #xxx - Follow-up: Appropriate direct description of changes`*
+ - *`Issue #1643 - Follow-up: Make sure things aren't changed while iterating.`*
### Commits with no issue
|