Skip to content

Commit ea93d22

Browse files
authored
chore: use headings in bug report templates (#1967)
* chore: use headings in bug report templates * chore: use heading level 2 to add underline
1 parent 508bb7f commit ea93d22

File tree

3 files changed

+27
-21
lines changed

3 files changed

+27
-21
lines changed

.github/ISSUE_TEMPLATE/---bug-report.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,29 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## Describe the bug
1111
A clear and concise description of what the bug is.
1212

13-
**SDK version number**
13+
## Your environment
14+
#### SDK version number
15+
`@aws-sdk/package-name@version`
1416

15-
**Is the issue in the browser/Node.js/ReactNative?**
17+
#### Is the issue in the browser/Node.js/ReactNative?
1618
Browser/Node.js/ReactNative
1719

18-
**Details of the browser/Node.js/ReactNative version**
20+
#### Details of the browser/Node.js/ReactNative version
1921
Paste output of `npx envinfo --browsers` or `node -v` or `react-native -v`
2022

21-
**To Reproduce (observed behavior)**
22-
Steps to reproduce the behavior (please share code or minimal repo)
23+
## Steps to reproduce
24+
Please share code or minimal repo, and steps to reproduce the behavior.
25+
#### Observed behavior
26+
A clear and concise description of what happens.
2327

24-
**Expected behavior**
25-
A clear and concise description of what you expected to happen.
28+
#### Expected behavior
29+
A clear and concise description of what you were expecting to happen.
2630

27-
**Screenshots**
31+
#### Screenshots
2832
If applicable, add screenshots to help explain your problem.
2933

30-
**Additional context**
34+
## Additional context
3135
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/---feature-request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
### Is your feature request related to a problem? Please describe.
1111
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1212

13-
**Describe the solution you'd like**
13+
### Describe the solution you'd like
1414
A clear and concise description of what you want to happen.
1515

16-
**Describe alternatives you've considered**
16+
### Describe alternatives you've considered
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

19-
**Additional context**
19+
### Additional context
2020
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/--documentation.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ assignees: ''
77

88
---
99

10-
**Describe the issue with documentation**
10+
## Describe the issue with documentation
1111
A clear and concise description of what the issue is.
1212

13-
**To Reproduce (observed behavior)**
14-
Steps to reproduce the behavior (please share code or minimal repo)
13+
## Steps to reproduce
14+
Please share code or minimal repo if required, and steps to reproduce the behavior.
15+
#### Observed behavior
16+
A clear and concise description of what happens.
1517

16-
**Expected behavior**
17-
A clear and concise description of what you expected to happen.
18+
#### Expected behavior
19+
A clear and concise description of what you were expecting to happen.
1820

19-
**Screenshots**
21+
#### Screenshots
2022
If applicable, add screenshots to help explain your problem.
2123

22-
**Additional context**
24+
## Additional context
2325
Add any other context about the problem here.

0 commit comments

Comments
 (0)