Adding rule for recommendation phrasing#90
Merged
Conversation
iadjivon
reviewed
Apr 23, 2026
| @@ -0,0 +1,9 @@ | |||
| # This file is used to lint passive "it is recommended" phrasing. | |||
There was a problem hiding this comment.
A very meta suggestion for the comment: 😅
- Use this file to lint passive "it is recommended" phrasing.
- Lint passive "it is recommended" phrasing using this file.
Contributor
Author
There was a problem hiding this comment.
LOL @iadjivon ! this is such a valid suggestion, especially given the purpose of the file. however, it looks like all the files in https://github.com/DataDog/datadog-vale/tree/main/styles/Datadog have a comment that uses this "This file is used to..." structure. so I will keep it passive for consistency 😭
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
adds a warning for passive "it is recommended" phrasing and suggests using "Datadog recommends" instead.
Motivation
@buraizu reminded me of this convention in his review of my PR! thanks Bryce!
Release
I don't think this PR requires a release! looking at the Releases page, they seem infrequent and not required for new rules to be disseminated to this repo's users
Additional Notes
n/a
Release checklist