rust-lang / rust-lang/rust-forge
dev-desktop: Git email config docs doesn't match implementation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 568
- Forks
- 253
- Avg merge
- 5h 33m
- Merged PRs (30d)
- 12
Description
The dev-desktop docs say you should check that your email has been setup before running init.sh
However running init.sh is what sets up a users git to have their name and email (from rust-lang/team)
We should change the docs to first have user's run init.sh, and then check that their gitconfig is correct.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update src/infra/docs/dev-desktop.md around lines 54-81. Compare the documented order with ansible/roles/dev-desktop/files/scripts/init.sh, then revise the instructions so users run init.sh before checking their Git name and email. Done means the documentation matches the script’s setup behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100