From 547745b1f459a080724be253de5cef7b1d290171 Mon Sep 17 00:00:00 2001 From: Stephen L Arnold Date: Thu, 12 Jun 2025 23:13:54 -0700 Subject: [PATCH] chg: doc: beef up the template instructions, edit for clarity Signed-off-by: Stephen L Arnold --- README.rst | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index b8362ae..bb9e9c2 100644 --- a/README.rst +++ b/README.rst @@ -5,13 +5,17 @@ Python project using simple setuptools project config; note package data, scripts, entry points, etc, **all still work** using pyproject.toml per `setuptools documentation`_. +To create a new repository using this template, click the button labeled +**Use this template** and select **Create a new repository**. + |ci| |wheels| |bandit| |release| |pre| |cov| |pylint| |tag| |license| |reuse| |python| -To use this template, replace the example project name with your own: +After creating your repository, replace the example project name "simple" +with your own: * change the project name at the top of ``pyproject.toml`` * change the project name in ``docs/source/conf.py`` *and* ``docs/source/index.rst`` @@ -19,6 +23,18 @@ To use this template, replace the example project name with your own: * change the package directory name under the ``src`` folder * change the github URL paths in ``pyproject.toml`` +Make a ``badges`` branch +------------------------ + +Create an orphan branch for Pylint and Coverage workflows. In a fresh +checkout, run the following commands:: + + $ git checkout --orphan badges + $ git reset --hard + $ git commit --allow-empty -m "Initializing badges branch" + $ git push origin badges + $ git checkout main + .. _setuptools documentation: https://setuptools.pypa.io/en/latest/userguide/package_discovery.html @@ -79,19 +95,6 @@ extra features: status checks -Make a ``badges`` branch ------------------------- - -Create an orphan branch for Pylint and Coverage workflows. In a fresh -checkout, run the following commands:: - - $ git checkout --orphan badges - $ git reset --hard - $ git commit --allow-empty -m "Initializing badges branch" - $ git push origin badges - $ git checkout main - - Dev tools ========= @@ -141,6 +144,9 @@ To build/lint the api docs, use the following tox commands: * ``tox -e cdocs`` run ``make clean`` in the docs build +Gitchangelog +------------ + We use gitchangelog_ to generate a changelog and/or release notes, as well as the gitchangelog message format to help it categorize/filter commits for tidier output. Please use the appropriate ACTION modifiers