PrismJS/prism

Add contributing docs

Open

#309 geöffnet am 30. Juli 2014

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (11.488 Stars) (1.296 Forks)batch import
docsenhancementgood first issue

Beschreibung

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
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.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Node.jsGulp workflow
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.