Port the `multirelease` file from APT to Markdown with the following changes:
A significant change is that large parts of the explanation about JEP-238
("forward compatibility problem") have been removed for the following reasons:

* We assume that multi-releases is now known well enough.
* The explanation used an obsolete example (Maven running on Java 6).
* The section was showing how to NOT use multi-releases (using reflection),
  which may be more a distraction than a help for the purpose of this page.

Removed most of the patterns for building a multi-releases project with Maven 3,
because many of them were referencing external web sites which are not available
anymore, or with content not obviously about multi-releases.
In particular, removed the following references:

* Reference to Animal Sniffer plugin, which is replaced by the `--release` option.
* Page http://word-bits.flurg.com/multrelease-jars/ is not available anymore (404).
* Page http://in.relation.to/2017/02/13/building-multi-release-jars-with-maven/ is blocked (security).
* Page http://www.russgold.net/sw/2018/04/easier-than-it-looks/ refers to above-cited blocked page.

Replaced "Maven module" by "Maven subproject" term for avoiding confusion with JPMS modules.
Removed the "all IDEs can only have one JDK per Maven Project, whereas with multi release you want to specify it per source folder."
This is not exactly true. We do not necessarily want different JDK, only different values for the `--release` option.

Added a section about multi-releases JAR projects with Maven 4.
2 files changed
tree: a0e4c27323b7313e7c20dc4f395d5304efb57bb4
  1. .github/
  2. src/
  3. .asf.yaml
  4. .git-blame-ignore-revs
  5. .gitignore
  6. Jenkinsfile.disable
  7. LICENSE
  8. NOTICE
  9. pom.xml
  10. README.md
README.md

Contributing to Apache Maven Compiler Plugin

Apache License, Version 2.0, January 2004 Maven Central Maven Central Reproducible Builds

You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code, there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • If you‘re planning to implement a new feature, it makes sense to discuss your changes on the dev list first. This way you can make sure you’re not wasting your time on something that isn‘t considered to be in Apache Maven’s scope.
  • Submit a ticket 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.

Build requirements

Building requires Maven 4. Executing the tests on Windows requires the developer mode. This is enabled with Settings > Update & Security > For Developers.

Making and Submitting Changes

We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us:

  • Create a topic branch from where you want to base your work (this is usually the master branch). Push your changes to a topic branch in your fork of the repository.
  • Make commits of logical units.
  • Respect the original code style: by using the same codestyle, patches should only highlight the actual difference, not being disturbed by any formatting issues:
    • 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 you have added the necessary tests (JUnit/IT) for your changes.
  • Run all the tests with mvn -Prun-its verify to assure nothing else was accidentally broken.
  • Submit a pull request to the repository in the Apache organization.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement.

Additional Resources