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

Align repo docs with NHSBSA standards

Aperta

#23 aperta il 20 mar 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Lua (1 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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').

Guida contributor

Direzione di ricerca
Esamina gli standard di documentazione del playbook digitale NHSBSA e confrontali con i documenti del repository esistente. Identifica le lacune e mappa le sezioni ai flussi di lavoro analitici dove necessario.
Tech stack
Nessuno
Dominio
documentationdeveloper experiencedata
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70