Skip to content

Commit 2ad24a7

Browse files
authored
[skip changelog] Fix pull request template markup (#1901)
* [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. * [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.
1 parent 9c784d8 commit 2ad24a7

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
**Please check if the PR fulfills these requirements**
1+
## Please check if the PR fulfills these requirements
2+
3+
See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/)
24

35
- [ ] The PR has no duplicates (please search among the [Pull Requests](https://github.com/arduino/arduino-cli/pulls)
46
before creating one)
@@ -8,23 +10,23 @@
810
- [ ] Docs have been added / updated (for bug fixes / features)
911
- [ ] `UPGRADING.md` has been updated with a migration guide (for breaking changes)
1012

11-
* **What kind of change does this PR introduce?**
13+
## What kind of change does this PR introduce?
14+
1215
<!-- Bug fix, feature, docs update, ... -->
1316

14-
- **What is the current behavior?**
17+
## What is the current behavior?
18+
1519
<!-- You can also link to an open issue here -->
1620

17-
* **What is the new behavior?**
21+
## What is the new behavior?
22+
1823
<!-- if this is a feature change -->
1924

20-
- **Does this PR introduce a breaking change, and is
21-
[titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?**
25+
## Does this PR introduce a breaking change, and is [titled accordingly](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#breaking)?
26+
2227
<!-- If this PR is merged, will any users need to change their code, command-line invocations, build scripts or data files
2328
when upgrading from an older version of Arduino CLI? -->
2429

25-
* **Other information**:
26-
<!-- Any additional information that could help the review process -->
27-
28-
---
30+
## Other information
2931

30-
See [how to contribute](https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/)
32+
<!-- Any additional information that could help the review process -->

0 commit comments

Comments
 (0)