commons-build:contributing-md

Overview

The commons-build:contributing-md goal generates a CONTRIBUTING.md file for a component. Execute the goal using the following command:

mvn commons-build:contributing-md

Note: The CONTRIBUTING.md only needs to be generated once or if the template changes.

This goal uses the following:

• The goal is mapped to the ant script/target using the contributing-md mojo definition in the generate-xdocs.mojos.xml mapping document
• Executes the contributing-md target in generate-xdocs.build.xml ant script
• Uses the contributing-md-template.md template
• Uses the goal's (i.e. mojo's) parameters to filter values in the template

Configuration

To generate a CONTRIBUTING.md, the following properties are configured in the component's pom.xml

• commons.jira.id - JIRA's external (upper case) project id for the component

Example configuration for Commons Text:

    <properties>
        <commons.jira.id>TEXT</commons.jira.id>
    </properties>