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

Add tests to identify rules with missing or incomplete guidance #613

Merged
merged 18 commits into from
May 23, 2024

Conversation

danfiedler-msft
Copy link
Contributor

@danfiedler-msft danfiedler-msft commented Apr 26, 2024

This PR adds two data-driven tests that verify rules:

  1. Specify a guidance file and that file exists
  2. The guidance file does not contain "TODO" or "TO DO"

It also adds guidance or points rules to the appropriate guidance file such that every default rule now has a guidance file.

The second test is temporarily marked as [Ignore] to allow builds to pass. I plan to work on updating the incomplete (those with TODOs) in the near future which will allow us to remove [Ignore] from that test.

@gfs gfs marked this pull request as draft April 29, 2024 23:50
@gfs
Copy link
Contributor

gfs commented Apr 29, 2024

Converted to draft so its slightly clearer not to merge yet (though the failing PR tests also give a hint.

@gfs
Copy link
Contributor

gfs commented Apr 30, 2024

Implementation of the tests looks spot on to me. Should sync on what to do about fixing the gaps/if they should be fatal yet as you mentioned.

@danfiedler-msft danfiedler-msft marked this pull request as ready for review May 23, 2024 18:08
@danfiedler-msft danfiedler-msft requested a review from gfs May 23, 2024 18:08
Copy link
Contributor

@gfs gfs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@danfiedler-msft danfiedler-msft merged commit 3e6a87e into main May 23, 2024
16 checks passed
@danfiedler-msft danfiedler-msft deleted the guidance-test branch May 23, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants