Google Git
Sign in
apache/maven-jar-plugin/refs/heads/fix-faq-code-markup
commit
30259b2860235ef97144f2b4e517f360a9cbc472
[log]
author
Sylwester Lachiewicz <slachiewicz@apache.org>
Mon Aug 10 01:01:15 2026 +0200
committer
Sylwester Lachiewicz <slachiewicz@apache.org>
Mon Aug 10 01:06:31 2026 +0200
tree
63ed856e831f671072bc2791b67b55925e2123f3
parent
70bc11874ad39e70a9766f94e90d75a086c5e263 [diff]
Render the archive parameter as code on the FAQ page

The FAQ answer was rewritten in #581 using Markdown backticks around
`archive`. FML is not Markdown: an <answer> body is parsed by Doxia's
XdocParser, which has no backtick handling, so the characters reach the
generated page verbatim. maven.apache.org currently shows

  The `archive` parameter is defined by the Maven Archiver library.

Use <code>, which is what the other 22 faq.fml files in the Maven estate
use for the same purpose.

The same sentence also gained a full stop in place of a comma, splitting
"defined by the Maven Archiver library, not by the Maven JAR Plugin" into
a sentence and a fragment. Fixed here since it is the same sentence and
the same origin.

Verified by building the site before and after: the only differences in
the rendered page are `archive` -> archive and library. -> library,. The
#question1 anchor is unchanged.

Generated-by: Claude Opus 5 (1M context)
1 file changed
tree: 63ed856e831f671072bc2791b67b55925e2123f3
  1. .github/
  2. src/
  3. .asf.yaml
  4. .gitignore
  5. AGENTS.md
  6. Jenkinsfile
  7. LICENSE
  8. NOTICE
  9. pom.xml
  10. README.md
  11. SECURITY.md
README.md

Contributing to Apache Maven JAR Plugin

Apache License, Version 2.0, January 2004 Maven Central 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.

Additional Resources