17
17
Contributing to [ Apache Maven Clean Plugin] ( https://maven.apache.org/plugins/maven-clean-plugin/ )
18
18
======================
19
19
20
- [ ![ ASF Jira] ( https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MCLEAN.json )] [ jira ]
21
20
[ ![ Apache License, Version 2.0, January 2004] ( https://img.shields.io/github/license/apache/maven.svg?label=License )] [ license ]
21
+ [ ![ Maven Central] ( https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-clean-plugin.svg?label=Maven%20Central&versionPrefix=3. )] ( https://search.maven.org/artifact/org.apache.maven.plugins/maven-clean-plugin )
22
22
[ ![ Maven Central] ( https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-clean-plugin.svg?label=Maven%20Central )] ( https://search.maven.org/artifact/org.apache.maven.plugins/maven-clean-plugin )
23
- [ ![ Reproducible Builds] ( https://img.shields.io/badge/Reproducible_Builds-ok-green?labelColor=blue )] ( https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-clean-plugin/README.md )
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-clean-plugin/badge.json )] ( https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-clean-plugin/README.md )
24
24
[ ![ Jenkins Status] ( https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master.svg? )] [ build ]
25
25
[ ![ Jenkins tests] ( https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master.svg? )] [ test-results ]
26
26
27
-
28
- You have found a bug or you have an idea for a cool new feature? Contributing
27
+ You have found a bug, or you have an idea for a cool new feature? Contributing
29
28
code is a great way to give something back to the open source community. Before
30
29
you dig right into the code, there are a few guidelines that we need
31
30
contributors to follow so that we can have a chance of keeping on top of
@@ -34,11 +33,10 @@ things.
34
33
Getting Started
35
34
---------------
36
35
37
- + Make sure you have a [ JIRA account] ( https://issues.apache.org/jira/ ) .
38
36
+ Make sure you have a [ GitHub account] ( https://github.com/signup/free ) .
39
- + If you're planning to implement a new feature, it makes sense to discuss your changes
40
- on the [ dev list] [ ml-list ] first.
41
- This way you can make sure you're not wasting your time on something that isn't
37
+ + If you're planning to implement a new feature, it makes sense to discuss your changes
38
+ on the [ dev list] [ ml-list ] first.
39
+ This way you can make sure you're not wasting your time on something that isn't
42
40
considered to be in Apache Maven's scope.
43
41
+ Submit a ticket for your issue, assuming one does not already exist.
44
42
+ Clearly describe the issue, including steps to reproduce when it is a bug.
@@ -57,44 +55,30 @@ There are some guidelines which will make applying PRs easier for us:
57
55
+ Respect the original code style: by using the same [ codestyle] [ code-style ] ,
58
56
patches should only highlight the actual difference, not being disturbed by any formatting issues:
59
57
+ Only use spaces for indentation.
60
- + Create minimal diffs - disable on save actions like reformat source code or organize imports.
58
+ + Create minimal diffs - disable on save actions like reformat source code or organize imports.
61
59
If you feel the source code should be reformatted, create a separate PR for this change.
62
60
+ Check for unnecessary whitespace with ` git diff --check ` before committing.
63
- + Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
64
- ```
65
- [MCLEAN-XXX] - Subject of the JIRA Ticket
66
- Optional supplemental description.
67
- ```
68
61
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
69
62
+ Run all the tests with ` mvn -Prun-its verify ` to assure nothing else was accidentally broken.
70
63
+ Submit a pull request to the repository in the Apache organization.
71
- + Update your JIRA ticket and include a link to the pull request in the ticket.
72
64
73
65
If you plan to contribute on a regular basis, please consider filing a [ contributor license agreement] [ cla ] .
74
66
75
- Making Trivial Changes
76
- ----------------------
77
-
78
- For changes of a trivial nature to comments and documentation, it is not always
79
- necessary to create a new ticket in JIRA. In this case, it is appropriate to
80
- start the first line of a commit with '(doc)' instead of a ticket number.
81
-
82
67
Additional Resources
83
68
--------------------
84
69
85
70
+ [ Contributing patches] ( https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch )
86
- + [ Apache Maven Clean JIRA project page] [ jira ]
87
71
+ [ Contributor License Agreement] [ cla ]
88
72
+ [ General GitHub documentation] ( https://help.github.com/ )
89
73
+ [ GitHub pull request documentation] ( https://help.github.com/send-pull-requests/ )
90
- + [ Apache Maven Twitter Account] ( https://twitter.com/ASFMavenProject )
91
- + #Maven IRC channel on freenode.org
74
+ + [ Apache Maven X Account] ( https://x.com/ASFMavenProject )
75
+ + [ Apache Maven Bluesky Account] ( https://bsky.app/profile/maven.apache.org )
76
+ + [ Apache Maven Mastodon Account
] ( https://mastodon.social/deck/@[email protected] )
92
77
93
- [ jira ] : https://issues.apache.org/jira/projects/MCLEAN/
94
78
[ license ] : https://www.apache.org/licenses/LICENSE-2.0
95
79
[ ml-list ] : https://maven.apache.org/mailing-lists.html
96
80
[ code-style ] : https://maven.apache.org/developers/conventions/code.html
97
81
[ cla ] : https://www.apache.org/licenses/#clas
98
82
[ maven-wiki ] : https://cwiki.apache.org/confluence/display/MAVEN/Index
99
- [ test-results ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master /lastCompletedBuild/testReport/
100
- [ build ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master /
83
+ [ test-results ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/maven-clean-plugin-3.x /lastCompletedBuild/testReport/
84
+ [ build ] : https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/maven-clean-plugin-3.x /
0 commit comments