rust-lang / rust-lang/rust-analyzer
Document how to regenerate the config section of `package.json`
Open
Nobody has claimed this yet.
A-documentation
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
Side note: Since docs/dev is lacking in that regard and it took me a while to figure out, you might want to mention somewhere that you only need to change config.rs and running cargo test will generate the rest.
Originally posted by @sclu1034 in https://github.com/rust-analyzer/rust-analyzer/pull/9051#issuecomment-850860175
Contributor guide
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 in docs/dev and inspect config.rs plus the generated config section of package.json. Verify that changing config.rs and running cargo test regenerates the section, then document this workflow in the appropriate developer documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100