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.

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

Improve consistency of linter rules messages #5470

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

felipecrs
Copy link

I spend some time reviewing the messages of these rules, and I found some little inconsistencies in the style. In my opinion this PR improves them.

Signed-off-by: Felipe Santos <felipecassiors@gmail.com>
@felipecrs
Copy link
Author

felipecrs commented Oct 30, 2024

Some patterns I came up with:

  1. Always refer to keywords using uppercase (e.g. FROM instead of from).
  2. Only quote strings if their content is unknown (i.e. entered by the user) (e.g. a stage name '%s'), or when otherwise the sentence would be confusing ('as' keyword instead of as keyword).
  3. Always use backticks ` to refer to snippets

Signed-off-by: Felipe Santos <felipecassiors@gmail.com>
@thompson-shaun thompson-shaun added this to the v0.18.0 milestone Oct 31, 2024
…e-ruleset-messages

Signed-off-by: Felipe Santos <felipecassiors@gmail.com>
@thompson-shaun
Copy link
Collaborator

@felipecrs I think the test cases will also need to be updated. 🙏

@felipecrs
Copy link
Author

For sure @thompson-shaun, I will get around to doing it soon. Please leave this on standby until I update it. Sorry.

@thompson-shaun
Copy link
Collaborator

No worries! Just wanted to call out in case it got lost in the pile. Thank you for the contribution. Reach out if you need assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants