PrismJS/prism

Add contributing guide

Open

#1.533 geöffnet am 19. Aug. 2018

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (11.488 Stars) (1.296 Forks)batch import
enhancementgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
MarkdownFamiliarity with Prism syntax highlighting
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.