From b15f37220df03336fc8ce62623ad46015920d377 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 2 Oct 2022 01:32:56 -0700 Subject: [PATCH 1/2] [skip changelog] Use correct markup for PR template headings This repository uses a pull request template in order to provide a standardized structure for pull request messages. The template imposes a framework for the organization of the pull request message by providing a section to contain each of the distinct types of important information to be included in the pull request. As should be obvious, the only correct formatting for section headings is heading markup, yet somehow list markup was chosen instead. This collides with the appropriate use of lists within the sections. The template is hereby changed to use the correct markup for headings. --- .github/PULL_REQUEST_TEMPLATE.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b028f0c4993..8f515e85aed 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -**Please check if the PR fulfills these requirements** +## Please check if the PR fulfills these requirements - [ ] The PR has no duplicates (please search among the [Pull Requests](https://github.com/arduino/arduino-cli/pulls) before creating one) @@ -8,21 +8,25 @@ - [ ] Docs have been added / updated (for bug fixes / features) - [ ] `UPGRADING.md` has been updated with a migration guide (for breaking changes) -* **What kind of change does this PR introduce?** +## What kind of change does this PR introduce? + -- **What is the current behavior?** +## What is the current behavior? + -* **What is the new behavior?** +## What is the new behavior? + -- **Does this PR introduce a breaking change, and is -[titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?** +## Does this PR introduce a breaking change, and is [titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)? + -* **Other information**: +## Other information + --- From 6c84c3c7f5d82a9aa0f244b55d0efa7d4e0c2fac Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 2 Oct 2022 01:43:09 -0700 Subject: [PATCH 2/2] [skip changelog] Move contributor guide link to appropriate section of PR template This repository uses a pull request template in order to provide a standardized structure for pull request messages. The template includes a link to the project's contributor guide. Previously, this link was at the bottom of the template, separated from the other content by a horizontal rule. One of the unfortunate ambiguities of the Markdown syntax is that the horizontal rule syntax is the same as the "setext" H2 heading syntax, with the differentiation depending on whether the prior line is empty. This results in text intended to be part of the "Other information" section of the PR message instead being formatted as an H2 heading if the contributor does not add an empty line at the end of the "Other information" section. Moving the link to the section of the template that contains a checklist for the PR requirements makes the relevant information readily accessible to the contributor while also avoiding the creation of a formatting trap. --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8f515e85aed..64204542882 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,7 @@ ## Please check if the PR fulfills these requirements +See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/) + - [ ] The PR has no duplicates (please search among the [Pull Requests](https://github.com/arduino/arduino-cli/pulls) before creating one) - [ ] The PR follows @@ -28,7 +30,3 @@ when upgrading from an older version of Arduino CLI? --> ## Other information - ---- - -See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/)