diff --git a/.gitar/rules/pr-description-quality.md b/.gitar/rules/pr-description-quality.md index 5297e3d8c12..02acaaf0ebc 100644 --- a/.gitar/rules/pr-description-quality.md +++ b/.gitar/rules/pr-description-quality.md @@ -9,7 +9,7 @@ actions: Read PR template for guidance then report requirement status When evaluating a pull request description: -1. **Read the PR template** at `.github/pull_request_template.md` to understand the expected guidance for each section +1. **Read the PR template guidance** at `.github/pull_request_guidance.md` to understand the expected guidance for each section 2. Apply that guidance to evaluate the current PR description 3. Provide recommendations for how to improve the description. diff --git a/.github/pull_request_guidance.md b/.github/pull_request_guidance.md new file mode 100644 index 00000000000..5f26ab30a1f --- /dev/null +++ b/.github/pull_request_guidance.md @@ -0,0 +1,55 @@ + +**What changed?** + + + +**Why?** + + + +**How did you test it?** + + + +**Potential risks** + + + +**Release notes** + + + +**Documentation Changes** + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7e535d77572..5b69c2d1027 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,58 +1,21 @@ - + **What changed?** - **Why?** - **How did you test it?** - **Potential risks** - **Release notes** - **Documentation Changes** - --- ## Reviewer Validation