From f59b0475b24bb532275d8ea9cab15c4580288b2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javi=20Mart=C3=ADn?= Date: Mon, 17 Jun 2024 19:13:40 +0200 Subject: [PATCH] Adjust heading levels in github templates Since the page contains an

tag (the title of the issue), the main headings of this file should be level 2 headings. We're removing the "How" section in the flaky specs template for simplicity (and because we usually don't use this template at all). Note that MDL reports that the first heading should be a level 1 heading, but, as mentioned earlier, this doesn't make sense in the context of a github issue. We'll probably exclude these files from MDL checks in order to avoid this issue. --- .github/ISSUE_TEMPLATE.md | 6 +++--- .github/ISSUE_TEMPLATE/flakies.md | 7 +------ 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b80a40074..3a761ce5e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,12 +1,12 @@ -### User Story +## User Story [comment]: # (As a , I want to so that .) -### Why is this Needed? +## Why is this Needed? [comment]: # (Describe the problem and why this task is needed. Provide a description of the current state, what you would like to happen, and what actually happened) -### Description +## Description [comment]: # (Feature or Bug? eg. Type: Bug) *Type*: diff --git a/.github/ISSUE_TEMPLATE/flakies.md b/.github/ISSUE_TEMPLATE/flakies.md index 6b0a02a0b..47ae2dac4 100644 --- a/.github/ISSUE_TEMPLATE/flakies.md +++ b/.github/ISSUE_TEMPLATE/flakies.md @@ -1,4 +1,4 @@ -# What +## What Tests that fail randomly are called "flakies", this one seems to be one: @@ -12,11 +12,6 @@ Tests that fail randomly are called "flakies", this one seems to be one: FILL_WITH_FAILURE_REPORT ``` -# How - -- [ ] Explain why the test is flaky, or under which conditions/scenario it fails randomly -- [ ] Explain why your PR fixes it - ## Tips for flaky hunting ### Random values issues