PrismJS/prism

Add contributing guide

Open

#1,533 opened on Aug 19, 2018

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (1,296 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (11,488 stars)
PR merge metrics
 (Avg merge 86d 15h) (12 merged PRs in 30d)

Description

A .md file with an introduction to how Prism works, how to write new languages / plugins / features, and tests for those features, would be really helpful.

Contributor guide

Research direction
Research Prism's internal architecture, plugin system, and testing framework to write a detailed contributing guide covering how to add languages, plugins, and features along with test examples.
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.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80