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 (316 stars) (11 forks)batch import
enhancementhelp wanted

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
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.
80
Research direction
Review the existing project structure and any existing docs. Look at how other open source projects structure their CONTRIBUTING.md. Focus on the topics mentioned: versioning, acceptance workflow/criteria, documentation. The guide should be written in a clear, welcoming tone for first time contributors.