Use @JIRA_ID@ instead of VFS as example
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk@1750673 13f79535-47bb-0310-9956-ffa450edef68 Project: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/commit/b1e36ffb Tree: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/tree/b1e36ffb Diff: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/diff/b1e36ffb Branch: refs/heads/master Commit: b1e36ffb03dffa92f75f940ca1791d089622fcc6 Parents: a649b14 Author: Stian Soiland-Reyes <[email protected]> Authored: Wed Jun 29 16:58:50 2016 +0000 Committer: Stian Soiland-Reyes <[email protected]> Committed: Wed Jun 29 16:58:50 2016 +0000 ---------------------------------------------------------------------- .../resources/commons-xdoc-templates/contributing-md-template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/b1e36ffb/src/main/resources/commons-xdoc-templates/contributing-md-template.md ---------------------------------------------------------------------- diff --git a/src/main/resources/commons-xdoc-templates/contributing-md-template.md b/src/main/resources/commons-xdoc-templates/contributing-md-template.md index d309a3e..cd23388 100644 --- a/src/main/resources/commons-xdoc-templates/contributing-md-template.md +++ b/src/main/resources/commons-xdoc-templates/contributing-md-template.md @@ -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.
