microsoft / microsoft/rust-guidelines
Clarify what guidelines apply to
Open
Nobody has claimed this yet.
request
- Dominant language
- Rust
- Stars
- 200
- Forks
- 25
- Avg merge
- 3m
- Merged PRs (30d)
- 1
Description
Either as tag in header, or ensure actual text makes it clear, e.g., (services, libraries, ...).
We mostly do that already with sections (Libraries, FFI, Applications) but some guidelines (e.g., M-LOG-STRUCTURED) might not apply to, say, high performance math libraries.
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
Review the existing Libraries, FFI, and Applications sections and the M-LOG-STRUCTURED guideline. Determine whether applicability should be shown in headers or in the guideline text, then clarify the scope of affected guidelines so cases such as high-performance math libraries are addressed.
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
- 48/100