Changes between Version 17 and Version 18 of TracDev/DevelopmentWorkflow

Timestamp:

Apr 27, 2020, 7:50:09 PM (4 years ago)

Author:

Ryan J Ollos

Comment:

Document [skip ci].

TracDev/DevelopmentWorkflow

@@ -17 +17 @@
 Commits should be atomic. If three separate issues are being fixed (unless they are all fixed by one change), they need to be done as three separate commits. This also applies to whitespace and style changes, which should be done in their own commit. Whitespace commits should not include code or content changes. Accordingly, code change commits should not include whitespace changes (unless the whitespace changes are on the same lines as the code being changed).
 
-Commit messages should describe what changed, and reference the issue number if the commit closes or is associated with a particular issue. Example:
+Commit messages should describe what changed, and reference the issue number if the commit closes or is associated with a particular issue.
 
+Example:
 {{{
 Version: Short Description
  
 Optional Long Description
- 
+
+[skip ci] (optional)
+
 Refs #zzz
 }}}
@@ -34 +37 @@
 
 There are two line breaks between the subject and the long description. The description can have any length and formatting, like lists, but it must be hard-wrapped at 80 characters.
+
+=== Skipping Build
+
+If you are confident the CI tests don't need to be
+run for this commit (e.g. a documentation change),
+add [[https://docs.travis-ci.com/user/customizing-the-build/#skipping-a-build|"[skip ci]"]].
 
 === References