Todo List to improve cookiecutter-py3-package docs

Todo

An automatic CHANGELOG now handles history—another small tutorial describing how-to create a release is required.

See Issue 36.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/pypi_release_checklist.rst, line 22.)

Todo

Create a tutorial to demonstrate GitHub protected branches configuration to make the best use of the create_repo_auto_test_workflow feature.

See Issue 72.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/reference/reference-project-inputs.rst, line 142.)

Todo

  1. Fix the git repo bash commands in Step 1 of the tutorial.

  2. The git bash commands may be better lower down the list as well.

See Issue 69.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorial.rst, line 33.)

Todo

Add a tutorial to describe using Test Pypi.

See Issue 13.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorial.rst, line 170.)

Todo

Write quickstart guide.

See Issue-82.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/quickstart.rst, line 19.)

Todo

Write Github Protected Branches guide.

See Issue-72.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-GH-protected-branches.rst, line 20.)

Todo

Write a PyPi guide.

See Issue-88.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-PyPi.rst, line 19.)

Todo

Write an auto-changelog guide.

See Issue-87.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-auto-changelog.rst, line 19.)

Todo

Write a console script guide.

See Issue-89.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-console-script.rst, line 18.)

Todo

Write a pre-commit guide.

See Issue-86.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-pre-commit.rst, line 19.)

Todo

Write Package Release guide.

See Issue-36.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-release-packagage.rst, line 20.)

Todo

Write a Semantic Version guide.

See Issue-90.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-sem-ver.rst, line 19.)

Todo

Write a simple workflow guide.

See Issue-85.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-py3-package/checkouts/latest/docs/source/tutorials/tutorial-workflow.rst, line 19.)