PrismJS/prism

Add contributing guide

Open

#1.533 aberto em 19 de ago. de 2018

Ver no 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.

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
MarkdownFamiliarity with Prism syntax highlighting
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
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.