index.Rmd

--- 
title: "DASD Coding Principles"
author: "Data Science Hub"
site: bookdown::bookdown_site
documentclass: book
#bibliography: [book.bib, packages.bib]
biblio-style: apalike
link-citations: yes
description: "These are the DASD coding principles."
output:
  html_document:
    toc: true
    toc_float:
      collapsed: true
      smooth_scroll: false
---

# Introduction {-#intro}

This document contains the Data and Analytical Service Directorate's (DASD) coding principles. These have been developed to help DASD adopt a standard approach for coding projects, ensuring that our work is high quality, maintainable and reusable and that we are able to collaborate effectively.

These coding principles are by no means a list of rules, but seek to provide guidance on how we can achieve 'best practice' in our coding - there will always be exceptions, but you should expect to be challenged if you go your own way. These ideas are always open to debate and you are encouraged to contribute to the discussion.

#### Document structure {-#structure}

The first part of this document contains the four [coding principles](#principles), with details on some practical actions that can be taken to follow them.

The second part of the document contains additional resources that may be helpful in understanding how to apply the principles, including the suggested [project workflow](#wf), a [project checklist](#checklist) and a [knowledge share resource list](#ksresources). 

If you're unfamiliar with the suggested workflow (particularly with regards to the use of Github), we recommend that you read through the [workflow section](#wf) before reading through the coding principles. This is because an understanding of the overall structure of a project will aid understanding of how and where the coding principles should be applied.

#### Contributing {-#contributing}

If you think that something is missing or not quite right you should either [contribute directly](#versioncontrol) or [raise an issue][01] on Github. 

[01]: https://github.com/moj-analytical-services/our-coding-standards/issues