rust-lang / rust-lang/rustfmt

Tracking issue for beefing up contribution docs

Open
#6,686 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-config A-contributor-onboarding C-tracking-issue
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

As part of the effort to onboard new contributors and maintainers, we probably want to extend contribution docs across several aspects:

And probably from POV of both PR authors and reviewers. Could consider a doc approach like https://diataxis.fr/.

We probably want to also double-check the present design docs at https://github.com/rust-lang/rustfmt/blob/5e937e0800ac2b3d7baee168f63f24ee01ccae6d/Design.md.

Potential follow-ups

  • Issue template for tracking issues

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 reviewing Contributing.md and Design.md, then compare their guidance with the linked RFC and the listed contribution areas. Break the tracking issue into focused documentation tasks, including test infrastructure, review and triage guidance, release logistics, and contribution paths. Done means the selected scope is documented and any follow-up issue is clearly defined.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.