less / less/less-docs

Contributing page suggestion

Open
#188 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Less
Stars
680
Forks
442
PR merge metrics
No merged PRs in 30d

Description

I suggest creating some easy-to-acces contributor's starting guide page (for contribution to less, not to the docs) or something. It should just contain a little description of the source tree. Sometimes repo's with a lot of files can seem a bit daunting, especially if you don't know what their purpose is.

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

Review the repository source tree and existing contribution guidance to identify the areas that need explaining. Add an accessible contributor starting guide for Less development, including a short description of the source tree; the work is done when a newcomer can use the guide to understand where project code belongs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.