Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce a new linter for diagnostic meesages #478

Closed
1 of 3 tasks
hkmatsumoto opened this issue Jan 3, 2022 · 3 comments
Closed
1 of 3 tasks

Introduce a new linter for diagnostic meesages #478

hkmatsumoto opened this issue Jan 3, 2022 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@hkmatsumoto
Copy link
Member

hkmatsumoto commented Jan 3, 2022 •
edited
Loading

Proposal

Introduce a linting system, separated from clippy or internal lints, for diagnostic messages on ui tests.

Motivation

Diagnostics play an important role in mitigating the steep learning curve of Rust. To make them easier to understand, their wording and use of punctuations should be consistent to some extent. Currently, it is the reviewer's job to spot inconsistency before being merged, but since reviewers are not omniscient and omnipotent, they sometimes overlook them (e.g., rust-lang/rust#89482, rust-lang/rust#89483).

Mentors or Reviewers

PR is at rust-lang/rust#89455

@estebank (assignee of the PR)

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

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.
@hkmatsumoto hkmatsumoto added T-compiler Add this label so rfcbot knows to poll the compiler team major-change A proposal to make a major change to rustc labels Jan 3, 2022
@rustbot
Copy link
Collaborator

rustbot commented Jan 3, 2022

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.

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Jan 3, 2022
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Jan 6, 2022
@estebank
Copy link

I am slightly concerned about diaglint living outside of the main repo. We have a very high to adding new deps. That being said, I am very much on favor of the idea, if not the approach.

@rustbot second

with the understanding that we will have to iterate on the specific approach before it can be merged/enabled.

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Jan 11, 2022
@apiraino
Copy link
Contributor

@rustbot label -final-comment-period +major-change-accepted

@rustbot rustbot added major-change-accepted A major change proposal that was accepted to-announce Announce this issue on triage meeting and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Jan 21, 2022
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@estebank @apiraino @rustbot @hkmatsumoto