-
Notifications
You must be signed in to change notification settings - Fork 74
setup typos check in CI (for rust repo) #817
Copy link
Copy link
Closed
Labels
T-compilerAdd this label so rfcbot knows to poll the compiler teamAdd this label so rfcbot knows to poll the compiler teammajor-changeA proposal to make a major change to rustcA proposal to make a major change to rustcmajor-change-acceptedA major change proposal that was acceptedA major change proposal that was accepted
Metadata
Metadata
Assignees
Labels
T-compilerAdd this label so rfcbot knows to poll the compiler teamAdd this label so rfcbot knows to poll the compiler teammajor-changeA proposal to make a major change to rustcA proposal to make a major change to rustcmajor-change-acceptedA major change proposal that was acceptedA major change proposal that was accepted
Type
Fields
Give feedbackNo fields configured for issues without a type.
Proposal
Add step to rust CI to check code/comments for typos, to keep things clean.
There was previous attempts to add this (links?), but they produced a lot of false positives. PR (rust-lang/rust#134006) adds that check and also contains (https://github.com/rust-lang/rust/blob/16ab024f2546607eb3f3aa3aa96eb3e382c442f5/typos.toml) short'ish exclusion list, so maintaining it should not be painful.
Currently implemented for: compiler, library, bootstrap, librustdoc.
Spellcheck did not break any other jobs on fail, it run separately and and results available in ~ 20 seconds.
Mentors or Reviewers
If you have a reviewer or mentor in mind for this work, mention them
here. You can put your own name here if you are planning to mentor the
work.
Process
The main points of the Major Change Process are as follows:
@rustbot second.-C flag, then full team check-off is required.@rfcbot fcp mergeon either the MCP or the PR.You can read more about Major Change Proposals on forge.
Comments
This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.