This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git
commit 8b95ad8294c77a5efcf9750737c5161b2f720ec4 Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Tue Nov 17 19:48:33 2026 +0000 Rewrite the README for users of the plugin Replaces the generic contributing template with what the plugin does, its Maven and Java floor, build commands and a short contributing section. The Jenkins badges are replaced by the GitHub Actions one: the Jenkins job is no longer reachable. --- README.md | 89 +++++++++++++++++++++++---------------------------------------- 1 file changed, 33 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 997affb..db2f13f 100644 --- a/README.md +++ b/README.md @@ -14,71 +14,48 @@ See the License for the specific language governing permissions and limitations under the License. --> -Contributing to [Apache Maven Help Plugin](https://maven.apache.org/plugins/maven-help-plugin/) -====================== -[][license] -[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-help-plugin) +# Apache Maven Help Plugin + +[](https://www.apache.org/licenses/LICENSE-2.0) +[](https://central.sonatype.com/artifact/org.apache.maven.plugins/maven-help-plugin) [](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-help-plugin/README.md) -[][build] -[][test-results] +[](https://github.com/apache/maven-help-plugin/actions/workflows/maven-verify.yml) + +The Help Plugin shows what Maven actually sees when it builds a project: the effective POM after inheritance and +profiles, the merged settings, the active profiles, the value of any expression, and the goals and parameters of any +plugin. It needs Maven 3.9.0 or later and Java 8 or later, and you don't have to add it to your POM: +```bash +mvn help:effective-pom -Dverbose +mvn help:evaluate -Dexpression=project.version -q -DforceStdout +mvn help:describe -Dplugin=compiler -Ddetail +``` -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. +The [plugin site](https://maven.apache.org/plugins/maven-help-plugin/) lists every goal, with +[usage examples](https://maven.apache.org/plugins/maven-help-plugin/usage.html). -Getting Started ---------------- +## Building -+ 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. +Build and run the unit tests: -Making and Submitting Changes --------------- +```bash +mvn verify +``` -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. +The integration tests under `src/it/projects` run with the `run-its` profile. To run a subset, name the projects: -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla]. +```bash +mvn -P run-its verify -Dinvoker.test=evaluate-forceStdout* +``` -Additional Resources --------------------- +## Contributing -+ [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://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork/) -+ [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/@[email protected]) +Report bugs and request features in [GitHub issues](https://github.com/apache/maven-help-plugin/issues), and send +changes as pull requests against `master`. Discuss larger features on the +[developer mailing list](https://maven.apache.org/mailing-lists.html) first. Code follows the +[Maven code style](https://maven.apache.org/developers/conventions/code.html), which Spotless enforces during the +build; run `mvn spotless:apply` before you push. Pull request titles become entries in the release notes. -[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-help-plugin/job/master/lastCompletedBuild/testReport/ -[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-help-plugin/job/master/ +See [helping with Maven](https://maven.apache.org/guides/development/guide-helping.html) for the wider project, and +the [contributor license agreements](https://www.apache.org/licenses/#clas) if you plan to contribute regularly.
