Contributing guide

This is the contributor guide for the govcookiecutter project.

• Code of conduct for govcookiecutter
  • Civil Service Code
  • Contributor Covenant Code of Conduct
• Contributing
  • Code of Conduct
  • Getting started
  • Code conventions
  • Testing
  • Documentation
  • Organisational frameworks
• Modifying govcookiecutter
  • cookiecutter template generation
  • Validating user entries
  • Conditional files and/or folders
  • Conditional file content
  • Replacing folders and files
  • Tests, coverage, and continuous integration
  • Releases
• organisation_frameworks folder
  • Analytical quality assurance (AQA) framework
  • Pull or merge request template
• Pre-commit hooks
  • Purpose
  • Installation
  • Using the detect-secrets pre-commit hook
  • Keeping specific Jupyter notebook outputs
  • Pre-commit hooks in the {{ cookiecutter.repo_name }} folder
• Updating the .gitignore file
  • .gitignore in the {{ cookiecutter.repo_name }} folder
• Writing accessible documentation
• Writing Sphinx documentation
  • Why should I bother? And why Sphinx?
  • Writing in reStructuredText
  • Writing in ReST-enabled Markdown