Repository: commons-compress Updated Branches: refs/heads/master 7e827527f -> 9da94ed62
update commons-build generated pages Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/9da94ed6 Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/9da94ed6 Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/9da94ed6 Branch: refs/heads/master Commit: 9da94ed620cd35ec3aa98a98a5297a2855fecd3c Parents: 7e82752 Author: Stefan Bodewig <bode...@apache.org> Authored: Mon Aug 13 09:05:48 2018 +0200 Committer: Stefan Bodewig <bode...@apache.org> Committed: Mon Aug 13 09:05:48 2018 +0200 ---------------------------------------------------------------------- CONTRIBUTING.md | 44 +++++++++++++++++++++++++++++++------------- README.md | 6 +++--- 2 files changed, 34 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-compress/blob/9da94ed6/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbf467b..aaa2c87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,48 +50,66 @@ Getting Started + Make sure you have a [JIRA account](https://issues.apache.org/jira/). + Make sure you have a [GitHub account](https://github.com/signup/free). -+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Compress's scope. -+ Submit a ticket for your issue, assuming one does not already exist. ++ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Compress's scope. ++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. + Clearly describe the issue including steps to reproduce when it is a bug. + Make sure you fill in the earliest version that you know has the issue. -+ Fork the repository on GitHub. ++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), +[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. Making Changes -------------- -+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch). ++ 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. `COMPRESS-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. `COMPRESS-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. - + Check for unnecessary whitespace with git diff --check before committing. -+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue. -+ Make sure you have added the necessary tests for your changes. + + 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. + + Check for unnecessary whitespace with `git diff` -- check before committing. ++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`. + Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken. Making Trivial Changes ---------------------- +The JIRA tickets are used to generate the changelog for the next release. + For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. + Submitting Changes ------------------ -+ Sign the [Contributor License Agreement][cla] if you haven't already. ++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already. + * Note that small patches & typical bug fixes do not require a CLA as + clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions) + covers them. + Push your changes to a topic branch in your fork of the repository. -+ Submit a pull request to the repository in the apache organization. ++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization. + * Verify _Files Changed_ shows only your intended changes and does not + include additional files like `target/*.class` + Update your JIRA ticket and include a link to the pull request in the ticket. +If you prefer to not use GitHub, then you can instead use +`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue. + + Additional Resources -------------------- + [Contributing patches](https://commons.apache.org/patches.html) -+ [Apache Commons Compress JIRA project page](https://issues.apache.org/jira/browse/COMPRESS) ++ [Apache Commons Compress JIRA project page][jira] + [Contributor License Agreement][cla] + [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) ++ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.net` [cla]:https://www.apache.org/licenses/#clas +[jira]:https://issues.apache.org/jira/browse/COMPRESS http://git-wip-us.apache.org/repos/asf/commons-compress/blob/9da94ed6/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index c51fe5d..b79acb2 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,8 @@ Apache Commons Compress =================== -[](https://travis-ci.org/apache/commons-compress) -[](https://coveralls.io/r/apache/commons-compress) +[](https://travis-ci.org/apache/commons-compress) +[](https://coveralls.io/r/apache/commons-compress) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-compress/) [](https://www.apache.org/licenses/LICENSE-2.0.html) @@ -101,7 +101,7 @@ Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/browse/compress) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COMPRESS) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) + `#apache-commons` IRC channel on `irc.freenode.org`
