Enhanced README.md
Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/c08816e8 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/c08816e8 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/c08816e8 Branch: refs/heads/MNG-6362 Commit: c08816e82a70d13a2d048acadce9a4b63cb841b3 Parents: caf92c0 Author: Karl Heinz Marbaise <khmarba...@apache.org> Authored: Mon Feb 19 19:49:34 2018 +0100 Committer: Karl Heinz Marbaise <khmarba...@apache.org> Committed: Mon Feb 19 23:27:44 2018 +0100 ---------------------------------------------------------------------- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/c08816e8/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index d8f302b..6cd6f87 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,6 @@ More information can be found on [Apache Maven Homepage][maven-home]. Question related to the usage of the Maven should be posted on the [Maven User List][users-list]. -If you are interested in the development of Maven please consult the -documentation first and afterwards you are welcome to join the developers -mailing list to ask question or discus new ideas / features / bugs etc. - -[Maven Wiki](https://cwiki.apache.org/confluence/display/MAVEN/Index) -[Building Maven](https://maven.apache.org/guides/development/guide-building-maven.html) -[Running Core ITs](https://maven.apache.org/core-its/core-it-suite/) - Where can I get the latest release? ----------------------------------- @@ -52,6 +44,13 @@ You can download release source from our [download page][maven-download]. Contributing ------------ +If you are interested in the development of Maven please consult the +documentation first and afterwards you are welcome to join the developers +mailing list to ask question or discus new ideas / features / bugs etc. + +Some of the ideas are documented in the [Maven Wiki][maven-wiki] +which might be intersting to read and for further discussion. + We accept Pull Requests via GitHub. The [developer mailing list][dev-ml-list] is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us: @@ -60,10 +59,10 @@ There are some guidelines which will make applying PRs easier for us: + 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. -+ Provide JUnit/Core IT tests for your changes and make sure your changes don't break ++ Provide JUnit/[Core IT tests][core-it] for your changes and make sure your changes don't break any existing tests by running ```mvn -Prun-its verify```. -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). +If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla]. You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). @@ -95,3 +94,8 @@ License [users-list]: http://maven.apache.org/mail-lists.html [dev-ml-list]: https://www.mail-archive.com/dev@maven.apache.org/ [code-style]: http://maven.apache.org/developers/conventions/code.html +[core-it]: https://maven.apache.org/core-its/core-it-suite/ +[building-maven: https://maven.apache.org/guides/development/guide-building-maven.html +[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index +[cla]: https://www.apache.org/licenses/#clas +