This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch maven-clean-plugin-3.x
in repository https://gitbox.apache.org/repos/asf/maven-clean-plugin.git
The following commit(s) were added to refs/heads/maven-clean-plugin-3.x by this
push:
new d720e18 Update README in 3.x branch
d720e18 is described below
commit d720e18eca9583639842aef52863c9625fea0353
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Mon Apr 28 22:06:54 2025 +0200
Update README in 3.x branch
---
README.md | 40 ++++++++++++----------------------------
1 file changed, 12 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 5e3a867..894a089 100644
--- a/README.md
+++ b/README.md
@@ -17,15 +17,14 @@
Contributing to [Apache Maven Clean
Plugin](https://maven.apache.org/plugins/maven-clean-plugin/)
======================
-[][jira]
[][license]
+[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-clean-plugin)
[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-clean-plugin)
-[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-clean-plugin/README.md)
+[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-clean-plugin/README.md)
[][build]
[][test-results]
-
-You have found a bug or you have an idea for a cool new feature? Contributing
+You have found a bug, or you have an idea for a cool new feature? Contributing
code is a great way to give something back to the open source community. Before
you dig right into the code, there are a few guidelines that we need
contributors to follow so that we can have a chance of keeping on top of
@@ -34,11 +33,10 @@ things.
Getting Started
---------------
-+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
-+ If you're planning to implement a new feature, it makes sense to discuss
your changes
- on the [dev list][ml-list] first.
- This way you can make sure you're not wasting your time on something that
isn't
++ If you're planning to implement a new feature, it makes sense to discuss
your changes
+ on the [dev list][ml-list] first.
+ This way you can make sure you're not wasting your time on something that
isn't
considered to be in Apache Maven's scope.
+ Submit a ticket for your issue, assuming one does not already exist.
+ 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:
+ Respect the original code style: by using the same [codestyle][code-style],
patches should only highlight the actual difference, not being disturbed by
any formatting issues:
+ Only use spaces for indentation.
- + Create minimal diffs - disable on save actions like reformat source code
or organize imports.
+ + Create minimal diffs - disable on save actions like reformat source code
or organize imports.
If you feel the source code should be reformatted, create a separate PR
for this change.
+ Check for unnecessary whitespace with `git diff --check` before committing.
-+ Make sure your commit messages are in the proper format. Your commit message
should contain the key of the JIRA issue.
-```
-[MCLEAN-XXX] - Subject of the JIRA Ticket
- Optional supplemental description.
-```
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was
accidentally broken.
+ Submit a pull request to the repository in the Apache organization.
-+ Update your JIRA ticket and include a link to the pull request in the ticket.
If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement][cla].
-Making Trivial Changes
-----------------------
-
-For changes of a trivial nature to comments and documentation, it is not always
-necessary to create a new ticket in JIRA. In this case, it is appropriate to
-start the first line of a commit with '(doc)' instead of a ticket number.
-
Additional Resources
--------------------
+ [Contributing
patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Apache Maven Clean JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request
documentation](https://help.github.com/send-pull-requests/)
-+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
-+ #Maven IRC channel on freenode.org
++ [Apache Maven X Account](https://x.com/ASFMavenProject)
++ [Apache Maven Bluesky Account](https://bsky.app/profile/maven.apache.org)
++ [Apache Maven Mastodon
Account](https://mastodon.social/deck/@asfmavenproj...@fosstodon.org)
-[jira]: https://issues.apache.org/jira/projects/MCLEAN/
[license]: https://www.apache.org/licenses/LICENSE-2.0
[ml-list]: https://maven.apache.org/mailing-lists.html
[code-style]: https://maven.apache.org/developers/conventions/code.html
[cla]: https://www.apache.org/licenses/#clas
[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index
-[test-results]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master/lastCompletedBuild/testReport/
-[build]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/master/
+[test-results]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/maven-clean-plugin-3.x/lastCompletedBuild/testReport/
+[build]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-clean-plugin/job/maven-clean-plugin-3.x/
