jquery / jquery/learn.jquery.com

contribution guidelines not in sync with the rest of jquery

Open
#554 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
915
Forks
471
PR merge metrics
No merged PRs in 30d

Description

The contribution guidelines (https://github.com/jquery/learn.jquery.com/blob/master/CONTRIBUTING.md) are not in sync with other jquery projects (such as https://github.com/jquery/jquery.com/blob/master/CONTRIBUTING.md) and don't point you towards the overall guidelines (here: http://contribute.jquery.org/).

This means that first-time contributors have no idea how to do things correctly... :-/

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

Open CONTRIBUTING.md in learn.jquery.com and compare it with jquery.com’s CONTRIBUTING.md, then review the overall guidance at contribute.jquery.org. Done means the learn.jquery.com guidelines are brought in sync with the other project and point first-time contributors to the overall guidelines.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.