nhsbsa-data-analytics/nhsbsa-analytical-code-assurance-playbook

Align repo docs with NHSBSA standards

Open

#23 opened on Mar 20, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Lua (1 fork)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Standards https://nhsbsa.github.io/nhsbsa-digital-playbook/development/dev-documentation/

We should align our docs as much as possible. Some aspects may not apply, or need to be mapped to analytical workflows (e.g. 'building the application' and 'running the application' in the readme could be 'installing dependencies' and 'running the pipeline').

Contributor guide

Research direction
Review the NHSBSA digital playbook documentation standards and compare with the existing repo docs. Identify gaps and map sections to analytical workflows where needed.
Tech stack
None
Domain
documentationdeveloper experiencedata
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70