rust-lang / rust-lang/std-dev-guide
Document how to refactor large modules into smaller ones
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 90
- Forks
- 47
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
In https://github.com/rust-lang/rust/pull/81272 it was pointed out that refactoring to avoid the tidy file length check can be performance sensitive so we want to rollup=never on them.
Those PRs are also prone to merge conflicts so may need to be handled in chunks, which could also make checking diffs easier to make sure nothing actually changed in the move.
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
Start by reading rust-lang/rust#81272 and the discussion of the tidy file length check. Document how to split large modules, including the performance-sensitive rollup=never consideration, handling changes in chunks, and checking diffs for unintended changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100