@@ -21,9 +21,9 @@ Contributing to [Apache Maven Compiler Plugin](https://maven.apache.org/plugins/
21
21
[ ![ 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 )
22
22
[ ![ 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 )
23
23
[ ![ 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
+ <!--
25
25
[][build]
26
- [][test-results]
26
+ [][test-results]
27
27
-->
28
28
29
29
@@ -37,28 +37,34 @@ Getting Started
37
37
---------------
38
38
39
39
+ 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
43
43
considered to be in Apache Maven's scope.
44
44
+ Submit a ticket for your issue, assuming one does not already exist.
45
45
+ Clearly describe the issue, including steps to reproduce when it is a bug.
46
46
+ Make sure you fill in the earliest version that you know has the issue.
47
47
+ Fork the repository on GitHub.
48
48
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
+
49
55
Making and Submitting Changes
50
56
--------------
51
57
52
58
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.
54
60
There are some guidelines which will make applying PRs easier for us:
55
61
+ Create a topic branch from where you want to base your work (this is usually the master branch).
56
62
Push your changes to a topic branch in your fork of the repository.
57
63
+ Make commits of logical units.
58
64
+ Respect the original code style: by using the same [ codestyle] [ code-style ] ,
59
65
patches should only highlight the actual difference, not being disturbed by any formatting issues:
60
66
+ 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.
62
68
If you feel the source code should be reformatted, create a separate PR for this change.
63
69
+ Check for unnecessary whitespace with ` git diff --check ` before committing.
64
70
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
0 commit comments