(doc) Avoid using VFS example

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1750674 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stian Soiland-Reyes 2016-06-29 16:59:39 +00:00
parent 1f94186fa6
commit 1792c34603
1 changed files with 2 additions and 2 deletions

View File

@ -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. `COLLECTIONS-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. `COLLECTIONS-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.