Apache Commons logo

commons:contributing-md

Overview

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

mvn commons:contributing-md

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

This goal uses the following:

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 Chain:

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