Skip to content

Commit 52252b0

Browse files
authored
Use title for issue sesctions (#6244)
In markdown, syntax have meaning. Those shouldn't be bold text, but titles: - semantically it suggests something different - `**text**` are easy to be removed as they could be interpreted as placeholders - having titles allows deep linking
1 parent 22758ae commit 52252b0

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

.github/ISSUE_TEMPLATE/feature-request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ assignees: ''
1616
- [ ] I'd be willing to implement this feature ([contributing guide](https://yarnpkg.com/advanced/contributing))
1717
- [ ] This feature is important to have in this repository; a contrib plugin wouldn't do
1818

19-
**Describe the user story**
19+
## Describe the user story
2020

2121
A clear and concise description of what workflow is meant to be improved.
2222
Example: "As a developer, I often want to do <something>, but I often face <problem>".
2323

24-
**Describe the solution you'd like**
24+
## Describe the solution you'd like
2525

2626
A clear and concise description of what you want to happen. Consider that Yarn is used
2727
by many people, and your particular use case might not make sense to implement in the core.
2828

29-
**Describe the drawbacks of your solution**
29+
## Describe the drawbacks of your solution
3030

3131
This section is important not only to identify future issues, but also for us to see whether
3232
you thought through your request. When filling it, ask yourself what are the problems we could
3333
have maintaining what you propose. How often will it break?
3434

35-
**Describe alternatives you've considered**
35+
## Describe alternatives you've considered
3636

3737
A clear and concise description of any alternative solutions or features you've considered,
3838
and why you think they wouldn't be good enough. Start by: why not make it a plugin?

.github/PULL_REQUEST_TEMPLATE.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
**What's the problem this PR addresses?**
1+
## What's the problem this PR addresses?
2+
23
<!-- Describe the rationale of your PR. -->
34
<!-- Link all issues that it closes. (Closes/Resolves #xxxx.) -->
45

56
...
67

7-
**How did you fix it?**
8+
## How did you fix it?
9+
810
<!-- A detailed description of your implementation. -->
911

1012
...
1113

12-
**Checklist**
14+
## Checklist
15+
1316
<!--- Don't worry if you miss something, chores are automatically tested. -->
1417
<!--- This checklist exists to help you remember doing the chores when you submit a PR. -->
1518
<!--- Put an `x` in all the boxes that apply. -->

0 commit comments

Comments
 (0)