Google Git
Sign in
apache/maven-toolchains-plugin/refs/heads/master
commit
44956705ba6ba0ff6a750cdae1878f5bcf15e167
[log]
author
Elliotte Rusty Harold <elharo@users.noreply.github.com>
Mon Jul 27 11:02:32 2026 +0000
committer
GitHub <noreply@github.com>
Mon Jul 27 11:02:32 2026 +0000
tree
63f761abd511d1e04ae96ac9e5b1d19806baf8ad
parent
d6b2792cff7cf88609ded36b95a91303a0f78ed7 [diff]
Fix grammar, typos, and awkward phrasing in site docs (#188)

* Fix grammar, typos, and awkward phrasing in site docs

- custom.apt: its provides -> it provides
- index.apt.vm: Toolchains Plugins -> Toolchain Plugin (singular)
- index.apt.vm: discover and selects -> discovers and selects
- index.apt.vm: let user copy/paste -> lets the user copy and paste
- usage.apt.vm: plugin that require -> plugin that requires
- jdk.apt.vm: In plugin's selection -> In the plugin configuration
- jdk.apt.vm: clarify jdkHome is child of configuration element
- jdk.apt.vm: add missing articles (The, the)
- jdk-discovery.apt.vm: reword awkward useJdk sentence

* Improve clarity of generate JDK toolchains XML description

Clarified the description of the generate JDK toolchains XML goal to improve readability.

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
5 files changed
tree: 63f761abd511d1e04ae96ac9e5b1d19806baf8ad
  1. .github/
  2. src/
  3. .asf.yaml
  4. .git-blame-ignore-revs
  5. .gitignore
  6. Jenkinsfile
  7. LICENSE
  8. pom.xml
  9. README.md
README.md

Contributing to Apache Maven Toolchains Plugin

Apache License, Version 2.0, January 2004 Maven Central Reproducible Builds Jenkins Status Jenkins tests

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

  • Make sure you have a GitHub account.
  • If you‘re planning to implement a new feature, it makes sense to discuss your changes on the dev 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 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, 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.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement.

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