moja-global / moja-global/FLINT

Understanding the reason for an instruction

Open
#110 6 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
56
Forks
81
PR merge metrics
No merged PRs in 30d

Description

What does the current documentation state?
Screenshot_20211018-081338

Where is this stated?
This is a link to the page where the issue is raised from

Why do you want to improve the statement?
The need to improve the circled section of the page hinges upon a need to better understand why the instruction required of the user of the doc was given. That is, answering the question on, "why the user should make sure to have checked out to the develop Branch for the FLINT Installation?"
What is the reason for this requirement here? What is the implications of not taking the required action?
I strongly believe this is a knowledge gap that needs to be filled in to create better documentation and satisfy users' innate need to understand why they have to take a step.

Proposed statement
The proposed solution, hence, is to state clearly the reason for the action requirement, alongside possible implication of not taking the step.

Contributor guide

Open the contributing guide

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 with the Git and GitHub guide at docs.moja.global/en/latest/DevelopmentSetup/git_and_github_guide.html and locate the instruction to check out the develop branch before FLINT installation. Determine the reason for that requirement and the implication of skipping it, then update the circled documentation section and verify that the explanation matches the installation process.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.