Add branch install notes to readme (plus clean up)

.Rbuildignore

@@ -6,3 +6,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^.lintr$

.github/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to dfeshiny
+
+Try and make use of the [usethis](https://usethis.r-lib.org/) package wherever possible.
+
+When you initially clone the package, the first thing you'll need to do is install [devtools](https://devtools.r-lib.org/):
+
+```
+install.packages("devtools")
+```
+
+Then to load in the package in its current form:
+
+```
+devtools::load_all()
+```
+
+## Adding a package/dependency
+
+`usethis::use_package(<package_name>)`
+
+This will create a new script within the package R/ folder.
+
+Note that when adding a function from another package into one of the dfeshiny functions you will need to explicitly state the package in the function call, e.g.:
+
+```package::function()```
+
+Alternatively, if there's a lot of uses of a single function within one of our R scripts, you can call that function once at the top of the R script, e.g:
+
+```
+@' importFrom package function
+```
+
+For more information see the [roxygen2 documentation on declaring dependencies](https://roxygen2.r-lib.org/articles/namespace.html).
+
+## Creating a new function script
+
+`usethis::use_r(name = <script_name>)`
+
+This will create a new script within the package R/ folder.
+
+## Creating a new function test script
+
+`usethis::use_test(name = <script_name>)`
+
+This will create a new test script within the package testthat/ folder.
+
+## Updating the package version
+
+Once changes have been completed, reviewed and are ready for use in the wild, you
+can increment the package version using:
+
+`usethis::use_version()`
+
+Once you've incremented the version number, it'll add a new heading to news.md.
+
+Add a summary under news.md and then accept it's offer to commit on your behalf.
+
+Once pushed and on the main branch, create a new release in GitHub itself.
+
+## Running tests
+
+You should run the following lines to test the package locally:
+``` 
+# To check functionality
+devtools::check() # Ctrl-Shft-E
+shinytest2::test_app("tests/test_dashboard") # important as not currently ran in CI checks
+
+# For code styling
+styler::style_pkg()
+lintr::lint_package()
+```

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+<!-- 
+Hey, thanks for raising a PR! We're excited to see what you've done!
+To help us review the changes, please complete each section in this template by replacing '...' with details to help the reviewers of this pull request. 
+-->
+
+# Brief overview of changes
+
+...
+
+## Why are these changes being made?
+
+...
+
+## Detailed description of changes
+
+...
+
+## Additional information for reviewers
+
+...
+
+## Issue ticket number/s and link
+
+...

.lintr

@@ -0,0 +1,3 @@
+linters:  linters_with_defaults(
+    line_length_linter = line_length_linter(100L) # limit CRAN sets for lines in PDF documentation
+  )

DESCRIPTION

@@ -29,7 +29,7 @@ Suggests:
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 URL: https://dfe-analytical-services.github.io/dfeshiny/
      https://www.github.com/dfe-analytical-services/dfeshiny/
 VignetteBuilder: knitr