Skip to content

Commit d720e18

Browse files
Update README in 3.x branch
1 parent 6c0745c commit d720e18

File tree

1 file changed

+12
-28
lines changed

1 file changed

+12
-28
lines changed

README.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,14 @@
1717
Contributing to [Apache Maven Clean Plugin](https://maven.apache.org/plugins/maven-clean-plugin/)
1818
======================
1919

20-
[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MCLEAN.json)][jira]
2120
[![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)
2222
[![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)
2424
[![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]
2525
[![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]
2626

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
2928
code is a great way to give something back to the open source community. Before
3029
you dig right into the code, there are a few guidelines that we need
3130
contributors to follow so that we can have a chance of keeping on top of
@@ -34,11 +33,10 @@ things.
3433
Getting Started
3534
---------------
3635

37-
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
3836
+ 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
4240
considered to be in Apache Maven's scope.
4341
+ Submit a ticket for your issue, assuming one does not already exist.
4442
+ 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:
5755
+ Respect the original code style: by using the same [codestyle][code-style],
5856
patches should only highlight the actual difference, not being disturbed by any formatting issues:
5957
+ 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.
6159
If you feel the source code should be reformatted, create a separate PR for this change.
6260
+ 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-
```
6861
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
6962
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
7063
+ 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.
7264

7365
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla].
7466

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-
8267
Additional Resources
8368
--------------------
8469

8570
+ [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]
8771
+ [Contributor License Agreement][cla]
8872
+ [General GitHub documentation](https://help.github.com/)
8973
+ [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])
9277

93-
[jira]: https://issues.apache.org/jira/projects/MCLEAN/
9478
[license]: https://www.apache.org/licenses/LICENSE-2.0
9579
[ml-list]: https://maven.apache.org/mailing-lists.html
9680
[code-style]: https://maven.apache.org/developers/conventions/code.html
9781
[cla]: https://www.apache.org/licenses/#clas
9882
[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

Comments
 (0)