You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@commons.apache.org by st...@apache.org on 2016/06/29 16:58:50 UTC

svn commit: r1750673 - /commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md

Author: stain
Date: Wed Jun 29 16:58:50 2016
New Revision: 1750673

URL: http://svn.apache.org/viewvc?rev=1750673&view=rev
Log:
Use @JIRA_ID@ instead of VFS as example

Modified:
    commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md

Modified: commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md
URL: http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md?rev=1750673&r1=1750672&r2=1750673&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md (original)
+++ commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md Wed Jun 29 16:58:50 2016
@@ -62,11 +62,11 @@ Making Changes
 
 + Create a _topic branch_ for your isolated work.
   * Usually you should base your branch on the `master` or `trunk` branch.
-  * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `VFS-614-MonitorInputStream`.
+  * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `@JIRA_ID@-123-InputStream`.
   * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
 + Make commits of logical units.
   * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
-  * e.g. `VFS-614: Close input stream early`
+  * e.g. `@JIRA_ID@-123: Close input stream earlier`
 + Respect the original code style:
   + Only use spaces for indentation.
   + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.