oakmac/cuttle

Cuttle should have a guide to contribution

Open

#100 opened on Feb 25, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (11 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (316 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We should encourage contribution by giving some instructions for regulars tasks.

Off the top of my head I can think about topics like:

  • Versioning
  • Acceptance Workflow / Criteria
  • Documentation

Contributor guide

Research direction
Write a CONTRIBUTING.md file covering versioning, acceptance workflow, and documentation standards.
Tech stack
javascript
Domain
developer experience
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.
1-3 hours
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.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85