Azure / Azure/review-checklists

JSON files should be validated according to the schema file automatically on every PR

Open
#699 0 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
1.3k
Forks
378
PR merge metrics
No merged PRs in 30d

Description

As discussed with @UmarMohamedUsman we have an [existing schema definition](https://github.com/Azure/review-checklists/blob/main/checklists/checklist.schema.json) which tells us the fields that are required in order for the JSON to be valid. It would be great to reference the schema in the JSON files (and drive VS Code IntelliSense probably? 🤔)... or at least have the JSON checked on every PR similar to the linting check.

Contributor guide

Open the contributing guide

Research direction

Start by reading checklists/checklist.schema.json and inspecting the repository’s existing linting check for how pull-request validation is configured. Ensure the JSON files are checked against the schema on every PR, or reference the schema for editor support, and verify the resulting PR check catches invalid required fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.