update setup.cfg description section to match input settings (#91)

* update setup.cfg description section to match input settings * Add python -m to README instructions * Fix broken links in contributing.md
best-practice-and-impact · Jun 21, 2023 · d57f84f · d57f84f
1 parent ce8e083
commit d57f84f
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -37,10 +37,7 @@ on pre-commit hooks see our documentation][docs-pre-commit-hooks].
 
 ### Git and GitHub
 
-We use Git to version control the source code. [Please read the GDS Way for details on
-Git best practice][gds-way-git]. This includes how to write good commit messages, use
-`git rebase` for local branches and `git merge --no-ff` for merges, as well as using
-`git push --force-with-lease` instead of `git push -f`.
+We use Git to version control the source code. [Please read the Quality assurance of code for analysis and research for details on Git best practice][duck-book-version-control]. This includes how to write good commit messages, how to branch correctly and solving merge conflicts.
 
 [If you want to modify the `.gitignore` files, see the template
 documentation][docs-updating-gitignore] for further details.
@@ -123,7 +120,7 @@ the `README.md` file in that folder.
 [docs-write-sphinx-documentation]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/writing_sphinx_documentation.md
 [email]: mailto:gsshelp@statistics.gov.uk
 [gds-way]: https://gds-way.cloudapps.digital/
-[gds-way-git]: https://gds-way.cloudapps.digital/standards/source-code.html
+[gds-way-git]: https://www.gov.uk/service-manual/technology/maintaining-version-control-in-coding
 [gds-way-python]: https://gds-way.cloudapps.digital/manuals/programming-languages/python/python.html#python-style-guide
 [govcookiecutter]: https://github.com/best-practice-and-impact/govcookiecutter
 [myst]: https://myst-parser.readthedocs.io/

diff --git a/README.md b/README.md
@@ -23,13 +23,13 @@ terminal, navigate to the directory where you want your new repository to exist.
 run the following command for the latest stable release:
 
 ```shell
-cookiecutter https://github.com/best-practice-and-impact/govcookiecutter.git
+python -m cookiecutter https://github.com/best-practice-and-impact/govcookiecutter.git
 ```
 
 or for a specific branch, tag, or commit SHA `{SPECIFIC}`, run:
 
 ```shell
-cookiecutter https://github.com/best-practice-and-impact/govcookiecutter.git --checkout {SPECIFIC}
+python -m cookiecutter https://github.com/best-practice-and-impact/govcookiecutter.git --checkout {SPECIFIC}
 ```
 
 Follow the prompts; if you are asked to re-download `govcookiecutter`, input `yes`.

diff --git a/tests/test_govcookiecutter_injected_variables.py b/tests/test_govcookiecutter_injected_variables.py
@@ -38,7 +38,7 @@
 }
 OVERVIEW_COUNT = {
     '"{{ cookiecutter.overview }}",': 0,
-    "{{ cookiecutter.overview }}": 1,
+    "{{ cookiecutter.overview }}": 2,
 }
 PROJECT_VERSION_COUNT = {
     '"{{ cookiecutter.project_version }}"': 2,
@@ -172,7 +172,7 @@ def recursive_open_and_count_search_terms(
     (
         "overview",
         "overview_1",
-        {**OVERVIEW_COUNT, "{{ cookiecutter.overview }}": 2},
+        {**OVERVIEW_COUNT, "{{ cookiecutter.overview }}": 3},
         {"using_R": "Yes"},
     ),
     ("project_version", "project_version_1", PROJECT_VERSION_COUNT, {"using_R": "No"}),

diff --git a/{{ cookiecutter.repo_name }}/docs/contributor_guide/CONTRIBUTING.md b/{{ cookiecutter.repo_name }}/docs/contributor_guide/CONTRIBUTING.md
@@ -37,10 +37,7 @@ documentation][docs-pre-commit-hooks].
 
 ### Git and GitHub
 
-We use Git to version control the source code. [Please read the GDS Way for details on
-Git best practice][gds-way-git]. This includes how to write good commit messages, use
-`git rebase` for local branches and `git merge --no-ff` for merges, as well as using
-`git push --force-with-lease` instead of `git push -f`.
+We use Git to version control the source code. [Please read the Quality assurance of code for analysis and research for details on Git best practice][duck-book-version-control]. This includes how to write good commit messages, how to branch correctly and solving merge conflicts.
 
 [If you want to modify the `.gitignore` files, see the template
 documentation][docs-updating-gitignore] for further details.
@@ -115,7 +112,7 @@ build the documentation into an accessible, searchable website.
 [docs-write-accessible-documentation]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/writing_accessible_documentation.md
 [docs-write-sphinx-documentation]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/writing_sphinx_documentation.md
 [gds-way]: https://gds-way.cloudapps.digital/
-[gds-way-git]: https://gds-way.cloudapps.digital/standards/source-code.html
+[duck-book-version-control]: https://best-practice-and-impact.github.io/qa-of-code-guidance/version_control.html
 [gds-way-python]: https://gds-way.cloudapps.digital/manuals/programming-languages/python/python.html#python-style-guide
 [myst]: https://myst-parser.readthedocs.io/
 [pre-commit]: https://pre-commit.com

diff --git a/{{ cookiecutter.repo_name }}/setup.cfg b/{{ cookiecutter.repo_name }}/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = {{ cookiecutter.repo_name }}
-description = a brief description
+description = {{ cookiecutter.overview }}
 version = {{ cookiecutter.project_version }}
 author = {{ cookiecutter.organisation_handle }}
 platforms = win32