mi6 / mi6/ic-ui-kit

Update contributing.md file to provide better documentation

Open
#1,228 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
TypeScript
Stars
53
Forks
63
Avg merge
2d 4h
Merged PRs (30d)
15

Description

## Summary
The contributing.md file is quite long and should probably be split out into separate docs to encourage people to read it more.

## 💬 Description
Each section of the contributing.md file should be split up and linked to from the contributing.md file. Essentially all of the top headings on the table of contents at the start of the contribution guide could be split up.

Coding standards and best practices may want to split out further as it is likely to be a large section after #1229 is implemented.

**Look into github docs to see if there's a nice way to format.**

## Why do we need it?
To encourage contributions following our standards.

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 by reading contributing.md and its table of contents, then review GitHub's documentation guidance for organizing contribution guides. Done means the top-level sections are split into separate linked documents, with coding standards and best practices considered for further separation after #1229.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.