@@ -5,20 +5,36 @@ Python project using simple setuptools project config; note package
55data, scripts, entry points, etc, **all still work ** using pyproject.toml
66per `setuptools documentation `_.
77
8+ To create a new repository using this template, click the button labeled
9+ **Use this template ** and select **Create a new repository **.
10+
811|ci | |wheels | |bandit | |release |
912
1013|pre | |cov | |pylint |
1114
1215|tag | |license | |reuse | |python |
1316
14- To use this template, replace the example project name with your own:
17+ After creating your repository, replace the example project name "simple"
18+ with your own:
1519
1620* change the project name at the top of ``pyproject.toml ``
1721* change the project name in ``docs/source/conf.py `` *and * ``docs/source/index.rst ``
1822* change the author details in ``pyproject.toml `` *and * ``docs/source/conf.py ``
1923* change the package directory name under the ``src `` folder
2024* change the github URL paths in ``pyproject.toml ``
2125
26+ Make a ``badges `` branch
27+ ------------------------
28+
29+ Create an orphan branch for Pylint and Coverage workflows. In a fresh
30+ checkout, run the following commands::
31+
32+ $ git checkout --orphan badges
33+ $ git reset --hard
34+ $ git commit --allow-empty -m "Initializing badges branch"
35+ $ git push origin badges
36+ $ git checkout main
37+
2238
2339.. _setuptools documentation : https://setuptools.pypa.io/en/latest/userguide/package_discovery.html
2440
@@ -79,19 +95,6 @@ extra features:
7995 status checks
8096
8197
82- Make a ``badges `` branch
83- ------------------------
84-
85- Create an orphan branch for Pylint and Coverage workflows. In a fresh
86- checkout, run the following commands::
87-
88- $ git checkout --orphan badges
89- $ git reset --hard
90- $ git commit --allow-empty -m "Initializing badges branch"
91- $ git push origin badges
92- $ git checkout main
93-
94-
9598Dev tools
9699=========
97100
@@ -141,6 +144,9 @@ To build/lint the api docs, use the following tox commands:
141144* ``tox -e cdocs `` run ``make clean `` in the docs build
142145
143146
147+ Gitchangelog
148+ ------------
149+
144150We use gitchangelog _ to generate a changelog and/or release notes, as
145151well as the gitchangelog message format to help it categorize/filter
146152commits for tidier output. Please use the appropriate ACTION modifiers
0 commit comments