riscv / riscv/docs-dev-guide

Update github actions

Open
#31 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

Right now, the stuff is in the readme file in the spec templates repo. Which is good because then you get them when you clone that repo. However, instructions should also be in the dev guide. Add them and also try to put in some help for updating an old repo.

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 the README in the spec templates repository and the existing documentation developer guide to understand how the instructions are organized. Add the GitHub Actions instructions to the developer guide and include guidance for updating an older repository; done means both workflows are documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.