PrismJS/prism

Add contributing guide

Open

#1533 opened on Aug 19, 2018

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

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

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.
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownFamiliarity with Prism syntax highlighting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
First, check if there are any existing contributing guidelines in the repository (e.g., CONTRIBUTING.md or similar). Review the structure of the project, especially how languages/plugins are added. Look at similar projects like Highlight.js for inspiration. The issue suggests including an introduction to Prism, how to write new languages/plugins/features, and tests. Focus on creating a clear outline for the document.