rust-lang / rust-lang/std-dev-guide

Document how we add content to the guide

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

Nobody has claimed this yet.

Dominant language
Shell
Stars
90
Forks
47
Avg merge
9h 22m
Merged PRs (30d)
1

Description

Do we want to signal sections of the guide that have had more thorough ratification than others? For the API Guidelines for instance we're now gating new changes to the content itself on FCPs, but that probably would've stopped us from ever getting it bootstrapped if we did that for a start.

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.

Research direction

No files or tests are named. Start with the guide's existing content-addition process and the API Guidelines example, then clarify how ratification status and FCP gating should be represented. Done means the guide documents an agreed process for adding content and signaling its level of review.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.