jquery / jquery/contribute.jquery.org

Contributing Code page

Open
#6 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
28
Forks
73
PR merge metrics
No merged PRs in 30d

Description

In page/code.md, following the mold of the triage page, put together instructions on the basics of contributing code to any jQuery project, e.g., forking repos, making pull requests, writing tests, not removing tests, following the style guide, using grunt, etc, with links to all the project repos.

This should probably link to the Won't Fix page, among other things as well.

Contributor guide

Open the contributing guide

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 with page/code.md and use the triage page as the model for structure and tone. Cover forking repositories, pull requests, tests, retaining existing tests, the style guide, Grunt, and links to all project repositories, including the Won't Fix page. Done means the page gives complete basic code-contribution instructions and links without removing the existing guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.