Skip to content

Commit 8ff2d3d

Browse files
committed
Documentation fixes from feedbacks.
1 parent 3f01ff8 commit 8ff2d3d

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Contributing to [Apache Maven Compiler Plugin](https://maven.apache.org/plugins/
2121
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-compiler-plugin.svg?label=Maven%20Central&versionPrefix=3.)](https://search.maven.org/artifact/org.apache.maven.plugins/maven-compiler-plugin)
2222
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-compiler-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.plugins/maven-compiler-plugin)
2323
[![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/org/apache/maven/plugins/maven-compiler-plugin/badge.json)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-compiler-plugin/README.md)
24-
<!--
24+
<!--
2525
[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-compiler-plugin/job/master.svg?)][build]
26-
[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-compiler-plugin/job/master.svg?)][test-results]
26+
[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-compiler-plugin/job/master.svg?)][test-results]
2727
-->
2828

2929

@@ -37,28 +37,34 @@ Getting Started
3737
---------------
3838

3939
+ Make sure you have a [GitHub account](https://github.com/signup/free).
40-
+ If you're planning to implement a new feature, it makes sense to discuss your changes
41-
on the [dev list][ml-list] first.
42-
This way you can make sure you're not wasting your time on something that isn't
40+
+ If you're planning to implement a new feature, it makes sense to discuss your changes
41+
on the [dev list][ml-list] first.
42+
This way you can make sure you're not wasting your time on something that isn't
4343
considered to be in Apache Maven's scope.
4444
+ Submit a ticket for your issue, assuming one does not already exist.
4545
+ Clearly describe the issue, including steps to reproduce when it is a bug.
4646
+ Make sure you fill in the earliest version that you know has the issue.
4747
+ Fork the repository on GitHub.
4848

49+
Build requirements
50+
--------------
51+
52+
Building requires Maven 4. Executing the tests on Windows requires the developer mode.
53+
This is enabled with _Settings_ > _Update & Security_ > _For Developers_.
54+
4955
Making and Submitting Changes
5056
--------------
5157

5258
We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is the
53-
main channel of communication for contributors.
59+
main channel of communication for contributors.
5460
There are some guidelines which will make applying PRs easier for us:
5561
+ Create a topic branch from where you want to base your work (this is usually the master branch).
5662
Push your changes to a topic branch in your fork of the repository.
5763
+ Make commits of logical units.
5864
+ Respect the original code style: by using the same [codestyle][code-style],
5965
patches should only highlight the actual difference, not being disturbed by any formatting issues:
6066
+ Only use spaces for indentation.
61-
+ Create minimal diffs - disable on save actions like reformat source code or organize imports.
67+
+ Create minimal diffs - disable on save actions like reformat source code or organize imports.
6268
If you feel the source code should be reformatted, create a separate PR for this change.
6369
+ Check for unnecessary whitespace with `git diff --check` before committing.
6470
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.

src/main/java/org/apache/maven/plugin/compiler/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Maven Compiler Plugin <abbr>MOJO</abbr>.
2222
* The {@link org.apache.maven.plugin.compiler.CompilerMojo}
2323
* and {@link org.apache.maven.plugin.compiler.TestCompilerMojo}
24-
* classes contains the configuration for compiling the main source code and the tests respectively.
24+
* classes contain the configuration for compiling the main source code and the tests respectively.
2525
* These classes are mutable as they can be extended and have their properties modified in subclasses.
2626
* However, the actual compilation is performed by {@link org.apache.maven.plugin.compiler.ToolExecutor},
2727
* which takes a snapshot of the <abbr>MOJO</abbr> at construction time. After the test executor has been

src/test/java/org/apache/maven/plugin/compiler/CompilerMojoTestCase.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,10 @@ public void testImplicitFlagNotSet(
291291
/**
292292
* Tests the compilation of a project having a {@code module-info.java} file, together with its tests.
293293
* The compilation of tests requires a {@code --patch-module} option, otherwise compilation will fail.
294+
*
295+
* <h4>Requirements on Windows</h4>
296+
* Executing the tests on Windows requires the developer mode.
297+
* This is enabled with {@literal Settings > Update & Security > For Developers}.
294298
*/
295299
@Test
296300
@Basedir("${basedir}/target/test-classes/unit/compiler-modular-project")

0 commit comments

Comments
 (0)