towncrier-usage.md

towncrier usage

Links go to contributor documention

• tox/README.rst
  • Trivial examples; no instructions
  • docs/changelog/
  • docs/changelog/template.jinja2
  • docs/changelog.rst
  • pyproject.toml
    • types = bugfix, feature, deprecation, breaking, doc, misc
    • underlines = ["-", "^"]
  • tox.ini
    • Run via release via script
• pytest/README.rst
  • Detailed style guide
  • changelog/
  • changelog/_template.rst
  • doc/en/changelog.rst
  • pyproject.toml
    • types = breaking, deprecation, feature, improvement, bugfux, vendor, doc, trivial
  • tox.ini
    • Run via docs and release via scripts
• dateutil/CONTRIBUTING.md
  • Style guide
  • changelog.d/
  • changelog.d/template.rst
  • NEWS
  • pyproject.toml
    • types = data, deprecations, feature, bugfix, doc, misc
  • tox.ini
    • Run via news
• attrs/CONTRIBUTING.rst
  • Style guide
  • changelog.d/
  • changelog.d/towncrier_template.rst
  • CHANGELOG.rst
  • pyproject.toml
    • types = breaking, deprecation, change
    • underlines = ["-", "^"]
  • tox.ini
    • Run via changelog
• setuptools/README.rst
  • Detailed rationale and style guide w/ examples
  • changelog.d/
  • towncrier_template.rst
  • CHANGES.rst
  • pyproject.toml: Lots of config
  • tox.ini
    • types = deprecation, breaking, change, doc, misc
    • Run via finalize via script
• virtualenv/development.rst
  • Detailed style guide
  • docs/changelog/
  • docs/changelog/examples.rst
  • docs/changelog/template.jinja2
  • docs/changelog.rst
  • pyproject.toml
    • default types
  • tox.ini
    • Run via release via script
• pip/contributing.rst
  • Detailed style guide, similar to virtualenv
  • news/
  • NEWS.rst
  • tools/automation/news/template.rst
  • pyproject.toml
    • types = process, removal, feature, bugfix, vendor, doc, trivial
  • Run via nox via script