1414 See the License for the specific language governing permissions and
1515 limitations under the License.
1616-->
17- Maven Enforcer Plugin - The Loving Iron Fist of Maven™
17+ Contributing to [ Maven Enforcer - The Loving Iron Fist of Maven™] ( https://maven.apache.org/enforcer/maven-enforcer-plugin )
1818======================================================
1919
2020[ ![ Apache License, Version 2.0, January 2004] ( https://img.shields.io/github/license/apache/maven-enforcer.svg?label=License )] [ license ]
@@ -27,57 +27,57 @@ The Enforcer plugin provides goals to control certain environmental constraints
2727such as Maven version, JDK version and OS family along with many more built-in
2828rules and user created rules.
2929
30- Documentation
31- -------------
32-
33- More information can be found on [ Apache Maven Enforcer Plugin Homepage] [ enforcer-home ] .
34- Question related to the usage of the Maven Enforcer Plugin should be posted on
35- the [ Maven User List] [ users-list ] .
36-
37- Where can I get the latest release?
38- -----------------------------------
39- You can download release source from our [ download page] [ enforcer-download ] .
40-
41- Contributing
42- ------------
43-
44- We accept Pull Requests via GitHub. The [ developer mailing list] [ dev-ml-list ] is the
30+ You have found a bug, or you have an idea for a cool new feature? Contributing
31+ code is a great way to give something back to the open source community. Before
32+ you dig right into the code, there are a few guidelines that we need
33+ contributors to follow so that we can have a chance of keeping on top of
34+ things.
35+
36+ Getting Started
37+ ---------------
38+
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
43+ considered to be in Apache Maven's scope.
44+ + Submit a ticket for your issue, assuming one does not already exist.
45+ + Clearly describe the issue, including steps to reproduce when it is a bug.
46+ + Make sure you fill in the earliest version that you know has the issue.
47+ + Fork the repository on GitHub.
48+
49+ Making and Submitting Changes
50+ --------------
51+
52+ We accept Pull Requests via GitHub. The [ developer mailing list] [ ml-list ] is the
4553main channel of communication for contributors.
4654There are some guidelines which will make applying PRs easier for us:
47- + No tabs! Please use spaces for indentation.
48- + Respect the [ code style] [ code-style ] .
49- + Create minimal diffs - disable on save actions like reformat source code or
50- organize imports. If you feel the source code should be reformatted create a
51- separate PR for this change.
52- + Provide JUnit/Invoker tests for your changes and make sure your changes don't break
53- any existing tests by running ``` mvn -Prun-its verify ``` .
54-
55- If you plan to contribute on a regular basis, please consider filing a [ contributor license agreement] ( https://www.apache.org/licenses/#clas ) .
56- You can learn more about contributing via GitHub in our [ contribution guidelines] ( CONTRIBUTING.md ) .
57-
58-
59- License
60- -------
61- This code is under the [ Apache Licence v2] [ license ]
62-
63- See the ` NOTICE ` file for required notices and attributions.
64-
65- Donations
66- ---------
67- You like Apache Maven? Then [ donate back to the ASF] ( https://www.apache.org/foundation/contributing.html ) to support the development.
68-
69- License
70- -------
71- [ Apache License, Version 2.0, January 2004] [ license ]
55+ + Create a topic branch from where you want to base your work (this is usually the master branch).
56+ Push your changes to a topic branch in your fork of the repository.
57+ + Make commits of logical units.
58+ + Respect the original code style: by using the same [ codestyle] [ code-style ] ,
59+ patches should only highlight the actual difference, not being disturbed by any formatting issues:
60+ + Only use spaces for indentation.
61+ + Create minimal diffs - disable on save actions like reformat source code or organize imports.
62+ If you feel the source code should be reformatted, create a separate PR for this change.
63+ + Check for unnecessary whitespace with ` git diff --check ` before committing.
64+ + Make sure you have added the necessary tests (JUnit/IT) for your changes.
65+ + Run all the tests with ` mvn -Prun-its verify ` to assure nothing else was accidentally broken.
66+ + Submit a pull request to the repository in the Apache organization.
67+
68+ If you plan to contribute on a regular basis, please consider filing a [ contributor license agreement] [ cla ] .
69+
70+ Additional Resources
71+ --------------------
72+
73+ + [ Contributing patches] ( https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch )
74+ + [ Contributor License Agreement] [ cla ]
75+ + [ Apache Maven X Account] ( https://x.com/ASFMavenProject )
76+ + [ Apache Maven Bluesky Account] ( https://bsky.app/profile/maven.apache.org )
77+ + [ Apache Maven Mastodon Account
] ( https://mastodon.social/deck/@[email protected] ) 7278
73- [ home ] : https://maven.apache.org/enforcer/maven-enforcer-plugin
7479[ license ] : https://www.apache.org/licenses/LICENSE-2.0
7580[ build ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/
7681[ test-results ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master/lastCompletedBuild/testReport/
77- [ build-status ] : https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master.svg?
78- [ build-tests ] : https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master.svg?
79- [ enforcer-home ] : https://maven.apache.org/enforcer/maven-enforcer-plugin/
80- [ enforcer-download ] : https://maven.apache.org/enforcer/download.cgi
81- [ users-list ] : https://maven.apache.org/mailing-lists.html
82- [ dev-ml-list ] :
https://www.mail-archive.com/[email protected] / 82+ [ ml-list ] : https://maven.apache.org/mailing-lists.html
8383[ code-style ] : https://maven.apache.org/developers/conventions/code.html
0 commit comments