Clarify license and contributions
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk@1750669 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/b240367c Tree: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/tree/b240367c Diff: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/diff/b240367c Branch: refs/heads/master Commit: b240367c669dc50c1e301947608bbd0093d94ac6 Parents: f546e06 Author: Stian Soiland-Reyes <[email protected]> Authored: Wed Jun 29 16:43:26 2016 +0000 Committer: Stian Soiland-Reyes <[email protected]> Committed: Wed Jun 29 16:43:26 2016 +0000 ---------------------------------------------------------------------- .../commons-xdoc-templates/readme-md-template.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/b240367c/src/main/resources/commons-xdoc-templates/readme-md-template.md ---------------------------------------------------------------------- diff --git a/src/main/resources/commons-xdoc-templates/readme-md-template.md b/src/main/resources/commons-xdoc-templates/readme-md-template.md index 3c6fced..37af855 100644 --- a/src/main/resources/commons-xdoc-templates/readme-md-template.md +++ b/src/main/resources/commons-xdoc-templates/readme-md-template.md @@ -48,7 +48,7 @@ Documentation ------------- -More information can be found on the [homepage](https://commons.apache.org/proper/commons-@ID@). +More information can be found on the [@NAME@ homepage](https://commons.apache.org/proper/commons-@ID@). The [JavaDoc](https://commons.apache.org/proper/commons-@ID@/javadocs/api-release) can be browsed. Questions related to the usage of @NAME@ should be posted to the [user mailing list][ml]. @@ -69,7 +69,7 @@ Alternatively you can pull it from the central Maven repositories: Contributing ------------ -We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors. +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us: + No tabs! Please use spaces for indentation. + Respect the code style. @@ -81,7 +81,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines License ------- -Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt). +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. Donations --------- @@ -91,8 +93,8 @@ Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/) ++ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.org` [ml]:https://commons.apache.org/mail-lists.html
