Govcookiecutter Versions Save

A cookiecutter template for data science projects within His Majesty's Government and wider public sector.

2.0.0

1 year ago

The folder structure has been changed to remove unnecessary files and folders.

1.3.2

1 year ago

Update flake8 to the most recent version Create make.bat file so windows users can use make commands Make 'direnv' optional To make direnv optional, move all variables from .envrc to .env in a variable=value format. Refactor .secrets to the same format. This allows windows users to use .secrets and environment variables

1.3.1

1 year ago

Update Flake8 from gitlab mirror to the github repository

1.3.0

1 year ago

Fix CI/CD Remove linkcheck from unit tests and workflows until a fix can be found update Black so it works with Click

1.2.3

2 years ago

Control of govcookiecutter has been transferred to Best Practice and Impact Division. With this transfer an updating of the documentation needed to be done to update correct divisional information. These changes can be found in the pull request Prepare project for transfer to ONS Best Practice and Impact team.

1.2.2

2 years ago

1.2.1

2 years ago

Changes include:

  • reverting the bump of the R pre-commit hooks in version 1.2.0 due to downstream issues and GitHub Actions issues. These will be addressed in future releases

1.2.0

2 years ago

Changes include:

  • bumping the R pre-commit hooks version (with thanks to @lorenzwalthert)
  • fixing GitHub Actions bug detailed in Issue #40

Update

Please use version 1.2.1 instead.

1.1.1

2 years ago

Changes include:

  • fixes to incorrect code examples
  • accessibility fixes

1.1.0

2 years ago

Changes include:

  • revising documentation to include further detail on the cookiecutter package, and how to modify the structure of govcookiecutter
  • fixing incorrect contact email address.
  • adding tests to check for broken links in the Sphinx documentation - ensures future releases of govcookiecutter have the correct links throughout the documentation
  • adding information on cruft, which could help future projects generated from govcookiecutter stay up-to-date with any changes we release here
  • refactoring documentation (Markdown/reStructuredText files only, predominately excluding CODE_OF_CONDUCT.md and CONTRIBUTING.md) so that it is more accessible, including guidance on how to write accessible documentation
  • GitHub Action to deploy documentation to GitHub Pages on release

Accessibility checks include:

  • building documentation against govuk-tech-docs-sphinx-theme
  • checking against WAVE Web Accessibility Evaluation Tool
  • checking link test is descriptive
  • checking hierarchy of page headings
  • removing italics, and bold text, and only using curly braces around block capitals for placeholders in code examples
  • checking for accessible language
    • using alex.js
    • replacing instances of click with select or choose
    • removing latin phrases, i.e. ad hoc, via
    • using GOV.UK inclusive language
    • replacing negative contractions
    • aiming not to have long sentences or paragraphs (25 words per sentence; 5 lines per paragraph)
    • checking for unique titles in documentation
    • checking diagrams and images for alt text as well as surrounding contextual text, removing diagrams/images that do not add anything to a user's understanding, removing screenshots if possible, use accessible SVGs
    • checking for inaccessible formats