Releases: best-practice-and-impact/govcookiecutter
Updated folder structure
The folder structure has been changed to remove unnecessary files and folders.
Add windows full functionality
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
v1.3.1
v1.3.0
Transfer to BPI
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
Changes include:
1.2.1
1.2.0
1.1.1
1.1.0
Changes include:
- revising documentation to include further detail on the
cookiecutter
package, and how to modify the structure ofgovcookiecutter
- 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 fromgovcookiecutter
stay up-to-date with any changes we release here - refactoring documentation (Markdown/reStructuredText files only, predominately excluding
CODE_OF_CONDUCT.md
andCONTRIBUTING.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
withselect
orchoose
- 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
- using