PrismJS / PrismJS/prism

Add contributing docs

Open
#309 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs enhancement good first issue
Dominant language
JavaScript
Stars
13k
Forks
1.4k
Avg merge
15h 36m
Merged PRs (30d)
3

Description

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing contribution documentation and the gulp workflow, then use issue #269 for context. Document general contribution steps, how the gulp workflow works, and how to install the required tooling; done means a newcomer can follow the documented setup and contribution process.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.