Skip to content

Minor formatting fixes #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Edited reference to cookiecutter tools
  • Loading branch information
BenCuff committed Aug 28, 2024
commit 00cb03eb70b01346389eba037060039f1697e080
4 changes: 2 additions & 2 deletions docs/rap-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ GitHub (or GitLab) can be used as a central repository to store your code and ve

Private repositories can be used for internal use only, or public repositories can be used to make your code more openly available. Please adhere to any organisational policy on creating open repositories.

It is important not to commit anything sensitive to version control repositories, such as datasets, secret keys and credentials. Datasets should be excluded to avoid disclosing any personal information. It is recommended that keys and credentials should be saved in a separate file that can still be used within the project, but which is excluded from the repository. Pre-commit hooks, such as those included within the [UKHSA Project Template](https://github.com/ukhsa-collaboration/ukhsa-project-template) (or the cross-government [“govcookiecutter” tool](https://best-practice-and-impact.github.io/govcookiecutter/#govcookiecutter)), or .gitignore exclusions can help mitigate this risk.
It is important not to commit anything sensitive to version control repositories, such as datasets, secret keys and credentials. Datasets should be excluded to avoid disclosing any personal information. It is recommended that keys and credentials should be saved in a separate file that can still be used within the project, but which is excluded from the repository. Pre-commit hooks, such as those included within the [cross-government “govcookiecutter” tool](https://best-practice-and-impact.github.io/govcookiecutter/#govcookiecutter), or .gitignore exclusions can help mitigate this risk.

Remember that even when sensitive information is included deep within the version history, these can be checked out and viewed! So you should adhere to these security principles right from the start of the project, or otherwise create a new repository with a clear version history.

Expand Down Expand Up @@ -349,4 +349,4 @@ In our silver standard, some principles have come from the Analysis Function’s
- “minimise manual steps” has been separated out into two principles covering manual steps during analysis and manual steps during the production of outputs, with the former remaining in the minimum bronze standard and the latter being moved to our silver standard; this is to recognise the fact that many analysts will develop the more basic programming skills needed for analysis first, before developing other skills around Rmarkdown, for example
- “validating input data”, “using functions”, and “adhere to a common best practice code style” have all been moved to our silver standard from the further standard because we have found that these are usually easier to implement than the other further standard principles

Aside from these differences, all other Analysis function “minimum” standard principles are in our bronze standard, and all other Analysis Function “further” standard principles are in our gold standard.
Aside from these differences, all other Analysis function “minimum” standard principles are in our bronze standard, and all other Analysis Function “further” standard principles are in our gold standard.