You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2018/12/24 19:07:09 UTC
[maven-site] branch master updated: contribution documentation
improvement
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new 9290102 contribution documentation improvement
9290102 is described below
commit 9290102761678baf91e87fad8c5f9cd419b6365f
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Dec 24 20:07:07 2018 +0100
contribution documentation improvement
---
content/apt/developers/conventions/jira.apt | 6 ++--
content/apt/developers/index.apt | 6 ++--
.../guides/development/guide-building-maven.apt | 33 +++++++++++++---------
content/apt/guides/development/guide-helping.apt | 16 +++++------
.../guides/development/guide-maven-development.apt | 12 ++------
5 files changed, 37 insertions(+), 36 deletions(-)
diff --git a/content/apt/developers/conventions/jira.apt b/content/apt/developers/conventions/jira.apt
index f133ad7..11a0b2b 100644
--- a/content/apt/developers/conventions/jira.apt
+++ b/content/apt/developers/conventions/jira.apt
@@ -32,13 +32,15 @@ Maven JIRA Convention
* When To Create a JIRA Issue?
- This section discusses when to create a JIRA issue versus just committing a change in SVN.
+ This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).
* <<Minor changes>>, like code reformatting, documentation fixes, etc. that aren't going to impact other users can
be committed without much issue.
* <<Larger changes>>, like bug fixes, API changes, significant refactoring, new classes, and pretty much any change
- of more than 100 lines, should have a JIRA ticket associated with it, or at least an email discussion.
+ of more than 100 lines, should have a JIRA ticket associated with it, or at least an email discussion.\
+ Creating a JIRA issue and referring it in commit comment will ease tracking what changes happen in a release,
+ using JIRA automatic release notes creation.
[]
diff --git a/content/apt/developers/index.apt b/content/apt/developers/index.apt
index 1c0a0b1..97e203f 100644
--- a/content/apt/developers/index.apt
+++ b/content/apt/developers/index.apt
@@ -39,13 +39,13 @@ Maven Developer Centre
* {{{../guides/development/guide-maven-development.html}Developing Maven}}
- * {{{../plugin-developers/common-bugs.html} Common Bugs and Pitfalls}}
-
* {{{../guides/development/guide-building-maven.html}Building Maven}}
+ * {{{../scm.html}Source Code}}
+
* {{{../continuous-integration.html}Continuous Integration}}
- * {{{../scm.html}Source Code}}
+ * {{{../plugin-developers/common-bugs.html} Common Bugs and Pitfalls}}
* {{{../project-roles.html}Apache Maven Project Roles}}
diff --git a/content/apt/guides/development/guide-building-maven.apt b/content/apt/guides/development/guide-building-maven.apt
index 3976af8..71b4a42 100644
--- a/content/apt/guides/development/guide-building-maven.apt
+++ b/content/apt/guides/development/guide-building-maven.apt
@@ -38,15 +38,10 @@ Building Maven
* to fix a problem you are having and submit a patch to the developers team.
- Note, that you don't need to bootstrap Maven for day to day use, or to develop plugins. While we encourage getting
- involved and fixing bugs that you find, for day to day use we recommend using the latest release.
-
* Checking out the sources
All of the source code for Maven and its related libraries is in managed in the ASF source code
- repositories. Current development of the core of Maven, and some other components, are in git.
- Other pieces (and older versions) are in Subversion. For details, see
- {{{/scm.html}https://maven.apache.org/scm.html}}.
+ repositories: for details, see {{{/scm.html}https://maven.apache.org/scm.html}}.
* Building Maven
@@ -58,15 +53,18 @@ Building Maven
mvn install
+-----+
- Before submitting a patch, it is advised to run the integration tests, which are available in a profile:
+*** Running Integration Tests
+
+ Before submitting a patch, it is advised to run the integration tests, which are available in the <<<run-its>>> profile:
+-----+
mvn -Prun-its install
+-----+
-** Building Maven With Maven Installed
+** Building Maven core
- If you already have Maven installed, it can be faster to build a new version with Maven, rather than a clean bootstrap.
+ Until Maven 3.3, Maven core build could be boostrapped with an Ant build. This bootstrap has been removed in Maven 3.5:
+ you need a pre-built Maven to build Maven from source.
To do this, run from the source directory:
@@ -74,15 +72,22 @@ mvn -Prun-its install
mvn install
+-----+
- The assemblies will be created in <<<apache-maven>>>, and can be unzipped to the location where you'd like Maven installed.
+ The assemblies will be created in <<<apache-maven>>>, and can be manually unzipped to the location where you'd like the resulting Maven installed.
+
+ If you want to have the resulting Maven directly copied to a directory, you can use the <<<distributionTargetDir>>> property:
+
++-----+
+mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-SNAPSHOT" install
++-----+
-** Running the full Maven core integration tests
+*** Running the full Maven core integration tests
- Before checking in a change or submitting a patch to Maven core, it is required to run the integration tests.
- These live in their own git repository. Using your local build of Maven, run:
+ Before checking in a change or submitting a patch to Maven core, it is required to run the core integration tests.
+ These live in their own {{{/core-its/source-repository.html}<<<maven-integration-testing.git>>> Git repository}}.
+ Using your local build of Maven, run:
+-----+
-mvn install -Prun-its
+mvn test -Prun-its
+-----+
Consult {{{/core-its/core-it-suite/}Core IT Suite documentation}} for more options.
diff --git a/content/apt/guides/development/guide-helping.apt b/content/apt/guides/development/guide-helping.apt
index f979e50..19a2b10 100644
--- a/content/apt/guides/development/guide-helping.apt
+++ b/content/apt/guides/development/guide-helping.apt
@@ -32,21 +32,23 @@ Guide to helping with Maven
As with any open source project, there are several ways you can help:
- * Join the {{{../../mailing-lists.html}mailing lists}} and answer other user's questions
+ * Join the {{{../../mailing-lists.html}mailing lists}} and answer other user's questions.
* Report bugs, feature requests and other issues in the {{{../../issue-management.html}issue management system}}.
* {{{./guide-building-maven.html} Build Maven}} for yourself, in order to fix bugs.
* {{{./guide-maven-development.html#Creating_and_submitting_a_patch}Submit patches}} to reported issues (both those you find,
- or that others have filed: we have a {{{https://s.apache.org/for-the-grabs_maven}list of issues that should be easy to solve}})
+ or that others have filed)\
+ To ease your first contribution, we have a {{{https://s.apache.org/for-the-grabs_maven}list of issues that should be easy to solve}}.
- * {{{./guide-testing-releases.html} test releases}} help test releases that are being voted on (see the dev@maven.apache.org {{{../../mailing-lists.html} mailing list}} for release votes
+ * {{{./guide-testing-releases.html} test releases}} help test releases that are being voted on (see the dev@maven.apache.org {{{../../mailing-lists.html} mailing list}} for release votes)
* {{{./guide-testing-development-plugins.html} test snapshot plugins}} help test the latest development versions of plugins and report issues
- * Help with the documentation by pointing out areas that are lacking or unclear, and if you are so inclined, submitting patches to correct it.
- You can create appropriate issues {{{https://issues.apache.org/jira/browse/MNGSITE}by using the issue management system}}.
+ * Help with the documentation by pointing out areas that are lacking or unclear, and if you can, submitting Pull Requests to correct it:
+ use the "edit" button in the breadcrumb, just after the page title.
+ You can also create appropriate issues {{{https://issues.apache.org/jira/browse/MNGSITE}by using the issue management system}}.
[]
@@ -85,11 +87,9 @@ Developers Conventions
* {{{../../developers/conventions/jira.html}Maven Jira Convention}}
- * {{{../../developers/conventions/svn.html}Maven Subversion Convention}}
-
* {{{../../developers/conventions/git.html}Maven Git Convention}}
- * {{{../../developers/release/index.html}Releasing a maven project}}
+ * {{{../../developers/release/index.html}Releasing a Maven project}}
[]
diff --git a/content/apt/guides/development/guide-maven-development.apt b/content/apt/guides/development/guide-maven-development.apt
index eaea236..b6ca9ce 100644
--- a/content/apt/guides/development/guide-maven-development.apt
+++ b/content/apt/guides/development/guide-maven-development.apt
@@ -38,10 +38,6 @@ Developing Maven
First of all you need something to work on! Issues can be found in
{{{/issue-management.html}several JIRA projects}}.
- * <<{{{https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=project%20%3D%20MNG%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20%22Planned%20Work%22%2C%20Request%2C%20Wish%29}JIRA Issues}}>>
-
- []
-
When you find a issue you would like to work on, add a comment in the issue log so the core developers and other
people looking for work know that someone is already working on it.
@@ -50,8 +46,6 @@ Developing Maven
See {{{/scm.html}https://maven.apache.org/scm.html}} for information.
The Maven project uses Git for some things and Subversion for others; and this
page tracks the situation.
-
- []
* Don't forget tests!
~~ TODO move details to guide-building-maven.apt, keep only principles here
@@ -115,7 +109,7 @@ $ patch -p0 < MNG-123.patch
* Patch acceptance criteria
-There are a number of criteria that a patch will be judged on:
+ There are a number of criteria that a patch will be judged on:
* Whether it works and does what is intended. This one is probably obvious!
@@ -135,8 +129,8 @@ There are a number of criteria that a patch will be judged on:
[]
-Above all, don't be discouraged. These are the same requirements the current committers should hold each other to as well.
-And remember, your contributions are always welcome!
+ Above all, don't be discouraged. These are the same requirements the current committers should hold each other to as well.
+ And remember, your contributions are always welcome!
* Related Projects