layer5io / layer5io/sistent

[Docs] Add relevant steps in opening issues in `CONTRIBUTING.md`

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

Nobody has claimed this yet.

area/docs follow-up framework/jekyll language/markdown
Dominant language
TypeScript
Stars
137
Forks
239
Avg merge
4d 14h
Merged PRs (30d)
5

Description

Current State
Desired State

Contributor Guides and Resources

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 the linked contributor guides, especially the instructions for contributing to documentation. Identify the missing steps for opening issues from the surrounding guidance, then update CONTRIBUTING.md so those steps are documented and consistent with the linked resources.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.