1 # Contributing to this module #

     2 

     3  * Work in a topic branch

     4  * Submit a github pull request

     5  * Address any comments / feeback

     6  * Merge into master using --no-ff

     7 

     8 # Releasing this module #

     9 

    10  * This module adheres to http://semver.org/

    11  * Look for API breaking changes using git diff vX.Y.Z..master

    12    * If no API breaking changes, the minor version may be bumped.

    13    * If there are API breaking changes, the major version must be bumped.

    14    * If there are only small minor changes, the patch version may be bumped.

    15  * Update the CHANGELOG

    16  * Update the Modulefile

    17  * Commit these changes with a message along the lines of "Update CHANGELOG and

    18    Modulefile for release"

    19  * Create an annotated tag with git tag -a vX.Y.Z -m 'version X.Y.Z' (NOTE the

    20    leading v as per semver.org)

    21  * Push the tag with git push origin --tags

    22  * Build a new package with puppet-module or the rake build task if it exists

    23  * Publish the new package to the forge

    24  * Bonus points for an announcement to puppet-users.