Provide custom messages for common errors

Open
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
ci-cd

Research direction

Start by locating the bot message generation and the handling for tidy-check failures; the issue specifically points to ./x.py test tidy as the check users should run. Done means tidy errors receive a short explanatory comment at the top of the bot's usual output while preserving the existing details.

Written by the indexing model from the issue text.

Description

Some errors are extremely common in Rust pull requests, for example: not passing the tidy check. In these cases, the workflow could be simplified even more, by displaying a comment at the top of the bot's message (accompanying the usual output), for example:

Run ./x.py test tidy to identify rustc style errors.
Your code fails the tidy check on the following lines:
[...]

This may be going over the top, reducing the single click to open the spoiler box; feel free to close if it's not worth the effort! It does let reviewers more quickly scan to see what the problem is, though.

Dominant language
Rust
Stars
52
Forks
27
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/rust-log-analyzer

All issues in rust-lang/rust-log-analyzer

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.