guardian/scribe

Add a section in CONTRIBUTING.md about the different labels for issues

Open

#283 opened on Oct 30, 2014

View on GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (3,516 stars) (265 forks)batch import
beginnerhelp wanted

Description

It would be nice to add an explanation of how users who want to work with scribe can get started. For example, we could add a list of task that need to be done in order of difficulty and add something about the different tags like "low hanging fruit"

Contributor guide

Tech stack
javascript
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic git and markdown skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Check the current CONTRIBUTING.md file (if it exists) and the repository's issue labels to identify common tags. Propose a section that explains the meaning of labels such as 'low hanging fruit' and suggests a list of tasks ordered by difficulty. Ensure the documentation is concise and helpful for newcomers.