The-Strategy-Unit / The-Strategy-Unit/nhp_inputs

Add QA page to wiki

Open
#692 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation should
Dominant language
R
Stars
2
Forks
1
Avg merge
15h 39m
Merged PRs (30d)
6

Description

Given limited room for in-depth information in the release checklists and README, we should write some more focused guidelines in the wiki for developers conducting QA on the inputs app. At the moment, 'you just have to know' certain things and so there's high potential for subtle issues and bugs. This could include detail about using the dev inputs selection app, how the upgrade steps work (including that dev scenarios cannot go through upgrade steps), etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the release checklists in .github/ISSUE_TEMPLATE, the README, and the wiki, then inspect the dev inputs selection app and the upgrade-step guidance mentioned in the issue. Document the QA workflow, including that dev scenarios cannot go through upgrade steps, so developers can follow the page without relying on undocumented knowledge.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.