Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
186 lines (122 sloc) 7.69 KB
------
Guide to Developing Maven
------
Emmanuel Venisse
Trygve Laugstol
Brett Porter
Maarten Mulders
------
2019-06-04
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License. You may obtain a copy of the License at
~~
~~ http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Developing Maven
This document describes how to get started developing Maven itself. There is a separate page describing how
to {{{./guide-building-maven.html}build Maven}}.
* Finding some work to do
First of all you need something to work on! Issues can be found in
{{{/issue-management.html}several JIRA projects}}.
Another good place to look for work is the {{{https://s.apache.org/up-for-grabs_maven} Up for grabs}} list.
This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge.
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.
* Where's the source?
See {{{/scm.html}https://maven.apache.org/scm.html}} for information.
The Maven project uses the Apache GitBox Repositories, and all of them are dual-mirrored to
{{{https://github.com/apache/} GitHub}}.
* Don't forget tests!
~~ TODO move details to guide-building-maven.apt, keep only principles here
You will find many unit tests. If at all possible, create or modify a unit test to demonstrate
the problem, and then validate your fix.
If the problem case can't be set up in the unit tests, add an integration test. Before submitting a patch, in any
case, you should run all of the integration tests. The tests require an empty local repository.
See {{{/core-its/core-it-suite/}Core IT Suite documentation}} for more details.
* {Creating and submitting a patch}
The most convenient way is to create a GitHub fork from the Git repository you are working with.
When you have either completed an issue or just want some feedback on the work you have done, create a pull request.
We have a couple of guidelines when submitting contributions:
* Create your branch from <<<master>>>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable
to the development head.
* If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.
* Name the branch after the issue number; the branch name would start with <<<\<jira-project-id>-<ticket-id\>>>>.
* Push your branch with the commit(s) to your fork.
* Create a {{{https://help.github.com/en/articles/about-pull-requests} pull request}} to submit your contribution.
Shortly after, someone will review the pull request and give you feedback on it.
[]
A short note:
* Make sure that you follow our code style, see {{{Further_Links}Further Links}}.
[]
* Pull request acceptance criteria
There are a number of criteria that a pull request will be judged on:
* Whether it works and does what is intended. This one is probably obvious!
* Whether it fits the spirit of the project. Some pull requests may be rejected as they take the project in a different
direction than the current development community has chosen. This is usually discussed on an issue well
before a pull request is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to
continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.
* Whether it contains tests. It is expected that any pull request relating to functionality will be accompanied by unit tests
and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis
for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage.
As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.
* Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough
for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community
we are striving to increase the current coverage of documentation.
[]
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
Maven has a few dependencies on other projects.
* <<Plexus>>
Plexus is a full-fledged container supporting different kinds of component lifecycles. Its native lifecycle
is like any other modern IoC container, using field injection of both requirements and configuration. All
core Maven functionality are Plexus components.
You can {{{https://codehaus-plexus.github.io/}read more about Plexus}}.
* <<Modello>>
Modello is a simple tool for representing an object model and generating code and resources from the model.
Maven uses Modello to generate all Java objects, XML readers and writers, XML Schema, and HTML documentation.
You can {{{https://codehaus-plexus.github.io/modello/}read more about Modello}}.
* <<Mojo>>
"Mojo" is really two things when it comes to Maven: it is both {{{/ref/current/maven-plugin-api/}Maven's plug-in API}}
and also {{{http://www.mojohaus.org}a separate Mojohaus project}} hosting a lot of plugins.
{{{http://www.mojohaus.org}The MojoHaus Project}} is a plugin forge for non-core Maven plugins.
There is also a lower bar for becoming a part of the project.
[]
* Sub Projects
** Maven Surefire
Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to
use it. It supports scripting tests in BeanShell and Jython and has special "batteries" for writing acceptance and
functional tests for the web and for testing XML-RPC code.
You can {{{/surefire/}read more about Surefire}}.
** Maven Doxia
Doxia is Maven's documentation engine. It has a sink and parser API that can be used to plug in support for input
and output documents.
You can read more about {{{/doxia/}Doxia}} and the currently supported
{{{/doxia/references/index.html}document formats}}.
** Maven SCM
Maven SCM (Source Control Management) is a reusable API which is independent of Maven itself. It is used by the
SCM related Maven Plugins. The core part of Maven doesn't depend on Maven SCM.
You can {{{/scm/}read more about Scm}}.
** Maven Wagon
Maven Wagon is a standalone API that deals with transporting files and directories. Maven Core uses the Wagon
API to download and upload artifacts and artifact metadata. The site plug-in uses it to publish the site.
You can {{{/wagon/}read more about Wagon}}.
* {Further Links}
* {{{../../developers/conventions/code.html}Maven Code Style And Code Convention}}
* {{{../../developers/conventions/jira.html}Maven JIRA Convention}}
* {{{../../developers/conventions/svn.html}Maven SVN Convention}}
[]
You can’t perform that action at this time.