Add a little clarity to the checklist

Open
#6 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by locating and reading the checklist referenced in the issue, then identify where its steps make readers jump between tasks without context. Add brief explanations that clarify what each section is doing and why the transitions occur. Done means a new engineer can follow the checklist without wondering what is happening.

Written by the indexing model from the issue text.

Description

enhancement help wanted

I haven't looked at this in a while and think the checklist could do with a little explanation seeing as it makes you jump all over the place and it's not always clear what is happening.

Dominant language
No language data
Stars
84
Forks
22
No merged PRs in 30d

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.

More from dwyl/dev-setup

All issues in dwyl/dev-setup

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.