Add an `CONTRIBUTING.md` to help people

Open Beginner friendly
#149 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Create CONTRIBUTING.md at the repository root and review the existing repository conventions before drafting it. Cover the conventions and expectations requested in the issue; consider whether issue templates belong in the same contribution guidance, with completion marked by a useful contributor document being present.

Written by the indexing model from the issue text.

Description

Helps with conventions and expectations. Issue templates might be helpful as well.

Dominant language
TypeScript
Stars
351
Forks
20
Avg merge
13h 49m
Merged PRs (30d)
34

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.

More from githubnext/chopin

All issues in githubnext/chopin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.