riscv / riscv/docs-dev-guide

Add info about updating a spec

Open
#72 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
142
Forks
41
Avg merge
14h 30m
Merged PRs (30d)
10

Description

Add a section that describes the spec states, what happens in each, and how to update each. Also provide some good details about how to get started with the template.

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 locating the documentation page for the spec workflow and the existing template guidance. Document each spec state, what happens in it, how to update it, and how to begin with the template; the issue is complete when these sections are present and usable by a new contributor.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.