Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.7 KB

CONTRIBUTING.rst

File metadata and controls

41 lines (32 loc) · 1.7 KB

Contributing

To contribute to the pulp_cookbook package follow this process:

  1. Clone the GitHub repo
  2. Make a change
  3. Make sure all tests passed
  4. To add an entry to the change log add a file into CHANGES folder (see :ref:`changelog-update` below)
  5. Commit changes to own pulp_cookbook clone
  6. Make pull request from github page for your clone against master branch

Changelog update

The CHANGES.rst file is managed using the towncrier tool and all non trivial changes must be accompanied by an entry.

To add an entry to the change log, you first need a pulp_cookbook issue describing the change you want to make. Once you have an issue, take its number and create a file inside of the CHANGES/ directory named after that issue number with an extension of .feature, .bugfix, .doc, .removal, or .misc. So if your issue is #3543 and it fixes a bug, you would create the file CHANGES/3543.bugfix.

PRs can span multiple categories by creating multiple files (for instance, if you added a feature and deprecated an old feature at the same time, you would create CHANGES/NNNN.feature and CHANGES/NNNN.removal). Likewise if a PR touches multiple issues you may create a file for each of them with the exact same contents and Towncrier will deduplicate them.

The contents of the files are reStructuredText formatted text that will be used as the content of the change log entry. You do not need to reference the issue or PR numbers here as towncrier will automatically add a reference to all of the affected issues when rendering the news file.