PrismJS/prism

Add contributing docs

Open

#309 opened on Jul 30, 2014

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (11,488 stars) (1,296 forks)batch import
docsenhancementgood first issue

Description

We need docs on how to contribute in general, how the newly introduced gulp workflow works and how you install all of it.

Docs for #269

Contributor guide

Tech stack
javascriptnodejs
Domain
documentationdeveloper experience
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.
half day
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
Node.jsGulp workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
First, review the repository for existing contributing documentation (e.g., CONTRIBUTING.md). Investigate the referenced issue #269 for details on the gulp workflow. Set up the project locally by following any existing setup instructions, then document the setup and contribution process clearly.