(doc) Avoid using VFS example git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1750674 13f79535-47bb-0310-9956-ffa450edef68
Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/1792c346 Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/1792c346 Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/1792c346 Branch: refs/heads/master Commit: 1792c34603cc5e9cb4aba1b97d27bba5a255b349 Parents: 1f94186 Author: Stian Soiland-Reyes <[email protected]> Authored: Wed Jun 29 16:59:39 2016 +0000 Committer: Stian Soiland-Reyes <[email protected]> Committed: Wed Jun 29 16:59:39 2016 +0000 ---------------------------------------------------------------------- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1792c346/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af47756..536b111 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.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. `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.
