You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/10/05 17:16:29 UTC
(maven-acr-plugin) 01/01: Turn the README into a project page and move contributing to CONTRIBUTING.md
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch agent/readme-modernize
in repository https://gitbox.apache.org/repos/asf/maven-acr-plugin.git
commit 9a98046dea006a26a5f6715d718525bc540cde8c
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Mon Oct 5 19:16:22 2026 +0200
Turn the README into a project page and move contributing to CONTRIBUTING.md
---
CONTRIBUTING.md | 37 +++++++++++++++++++++++++++
README.md | 77 ++++++++++++---------------------------------------------
2 files changed, 53 insertions(+), 61 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..71ee16c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,37 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Contributing
+
+Bug reports, fixes and new features are welcome. To keep reviews quick:
+
+- Discuss a new feature on the [dev mailing list](https://maven.apache.org/mailing-lists.html)
+ first, so you know it fits the project before you write it.
+- Report bugs in [GitHub Issues](https://github.com/apache/maven-acr-plugin/issues),
+ with the earliest affected version and steps to reproduce. Report security
+ issues privately, as [SECURITY.md](SECURITY.md) describes.
+- Open pull requests from a topic branch, in commits of logical units.
+- Add or update tests for your change, run `mvn spotless:apply` to format it,
+ and run `mvn -Prun-its verify` before you push.
+- Keep the diff minimal: leave unrelated formatting and import order alone,
+ and send a reformat as its own pull request.
+
+If you plan to contribute regularly, file an
+[Apache Individual Contributor License Agreement](https://www.apache.org/licenses/contributor-agreements.html#clas).
+
+More: [Maven developer guide](https://maven.apache.org/guides/development/guide-maven-development.html),
+[code conventions](https://maven.apache.org/developers/conventions/code.html).
diff --git a/README.md b/README.md
index d1c420d..c7c9743 100644
--- a/README.md
+++ b/README.md
@@ -14,70 +14,25 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-Contributing to [Apache Maven ACR Plugin](https://maven.apache.org/plugins/maven-acr-plugin/)
-======================
-[][license]
-[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-acr-plugin)
-[][build]
-[][test-results]
-
-
-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
-things.
-
-Getting Started
----------------
+# Apache Maven ACR Plugin
-+ 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
- 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.
- + Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
-
-Making and Submitting Changes
---------------
-
-We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is the
-main channel of communication for contributors.
-There are some guidelines which will make applying PRs easier for us:
-+ Create a topic branch from where you want to base your work (this is usually the master branch).
- Push your changes to a topic branch in your fork of the repository.
-+ Make commits of logical units.
-+ 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.
- 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 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.
+[](https://www.apache.org/licenses/LICENSE-2.0)
+[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-acr-plugin)
+[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-acr-plugin/README.md)
+[](https://github.com/apache/maven-acr-plugin/actions/workflows/maven-verify.yml)
-If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla].
+Builds Jakarta EE application client JARs. The plugin adds the `app-client`
+packaging and dependency type, and the `acr:acr` goal that packages them.
-Additional Resources
---------------------
+- Documentation: <https://maven.apache.org/plugins/maven-acr-plugin/>
+- Issues: <https://github.com/apache/maven-acr-plugin/issues>
+- Security reports: see [SECURITY.md](SECURITY.md); never a public issue
+- Contributing: see [CONTRIBUTING.md](CONTRIBUTING.md)
-+ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Contributor License Agreement][cla]
-+ [General GitHub documentation](https://help.github.com/)
-+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
-+ [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/@ASFMavenProject@fosstodon.org)
+## Build
-[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-acr-plugin/job/master/lastCompletedBuild/testReport/
-[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-acr-plugin/job/master/
+```shell
+mvn verify # unit tests
+mvn -Prun-its verify # unit and integration tests
+```