Skip to content

Remove contributing guidelines and QA information #5

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.

Sign up for GitHub

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

Open
adryden27 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove contributing guidelines and QA information #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 0 additions & 44 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1 @@
# Contributing guidelines

Each repository in DataS-DHSC should contain a README file and a QA log. QA guidance and templates can be found here: https://dhexchange.kahootz.com/connect.ti/Testanalysts/view?objectId=13590448

A sample QA template is also provided below.

In most cases, the master branch should only contain work that has been through a full QA process. An exception to this is if you need to set up a github action on the master branch (e.g. periodically scraping data) before the work has been fully QAd. If the master branch does not contain fully QAd work, then the QA log file should clearly reflect the current state of QA.


# Quality assurance information

Complete this template with any information about the model or analysis not previously stored in this repository. Please refer to relevant Quality Assurance procedures and standards.

## Basic information

* **Name of analytical team:**
* **Analysis type:** Policy simultation / Forecasting / Financial evaluation / Procurement & commercial / Planning / Science-based / Allocation
* **What does the model or analysis do?**
* **How are the outputs used?**
* **Security classification:**

## Scope
What is the scope of the project?

## Analysis Specification
What are the requirements?

## User documentation
Where is the user guide, and does it cover relevant risks?

## Technical documentation
Where is the explanation of technical aspects?

## Data register

| Data input | Data type | Time period | When to review | Data source / Business owner | Methodological notes | Reasoning | Quality RAG | Suitability RAG | Impact RAG |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| Description of data input | e.g. Published statistic, administrative data, etc. | When should data be updated | Source / persons responsible for data updates | Notes on data scope, collection, or transformation | Reasoning to support the use of the data input | Quality of assumptions | Suitability of data for analysis | Impact of assumptions on main outputs |

## Assumptions register

| Assumption | When to review | Assumption source / Business owner | Methodological notes | Reasoning | Quality RAG | Impact RAG |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| A description of the assumption | When should an update to the assumption be considered | Source or persons responsible for the assumption | Notes on the calculation of the assumption | Reasoning to support hte use of the assumption | Quality of the assumption | Impact of the assumption on the main outputs |