PrismJS/prism

Add contributing guide

Open

#1 533 ouverte le 19 août 2018

Voir sur GitHub
 (4 commentaires) (1 réaction) (0 assignés)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.

Guide contributeur

Stack technique
javascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
MarkdownFamiliarity with Prism syntax highlighting
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.