qmk/qmk_firmware

Omission in "How to Use GitHub with QMK" creates a tripping hazard

Open

#13,951 opened on Aug 10, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

System Information

  • Keyboard:
    • Revision (if applicable):
  • Operating system:
  • AVR GCC version:
  • ARM GCC version:
  • QMK Firmware version:
  • Any keyboard related software installed?
    • AutoHotKey
    • Karabiner
    • Other:

Additional Context

Contributor guide

Research direction
Locate the 'How to Use GitHub with QMK' documentation page and identify the missing content or step that creates a 'tripping hazard'.
Tech stack
c
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
GitQMK basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70