Skip to content

Commit 1639e17

Browse files
authored
Enhance PR/Issue templates readability (#4829)
2 parents 011ff85 + 7853df0 commit 1639e17

File tree

4 files changed

+21
-19
lines changed

4 files changed

+21
-19
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,33 @@ labels: bug
66
assignees: ''
77
---
88

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

12-
**To Reproduce**
12+
### To Reproduce
1313
Steps to reproduce the behavior:
1414

1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behavior**
20+
### Expected behavior
2121
A clear and concise description of what you expected to happen.
2222

23-
**Screenshots**
23+
### Screenshots
2424
If applicable, add screenshots to help explain your problem.
2525

26-
**Version info:**
27-
_Run `lazygit --version` and paste the result here_
28-
_Run `git --version` and paste the result here_
26+
### Version info:
2927

30-
**Additional context**
28+
* _Run `lazygit --version` and paste the result here_
29+
* _Run `git --version` and paste the result here_
30+
31+
### Additional context
3132
Add any other context about the problem here.
3233

33-
**Note:** please try updating to the latest version or [manually building](https://github.com/jesseduffield/lazygit/#manual) the latest `master` to see if the issue still occurs.
34+
> [!NOTE]
35+
> Please try updating to the latest version or [manually building](https://github.com/jesseduffield/lazygit/#manual) the latest `master` to see if the issue still occurs.
3436
3537
<!--
3638
If you want to try and debug this issue yourself, you can run `lazygit --debug` in one terminal panel and `lazygit --logs` in another to view the logs.

.github/ISSUE_TEMPLATE/discussion.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ assignees: ''
77

88
---
99

10-
**Topic**
11-
A clear and concise description of what you want to discuss
10+
### Topic
11+
A clear and concise description of what you want to discuss.
1212

13-
**Your thoughts**
14-
What you have to say about the topic
13+
### Your thoughts
14+
What you have to say about the topic.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ labels: enhancement
66
assignees: ''
77
---
88

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

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

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

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

2121
<!--

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
- **PR Description**
1+
### PR Description
22

3-
- **Please check if the PR fulfills these requirements**
3+
### Please check if the PR fulfills these requirements
44

55
* [ ] Cheatsheets are up-to-date (run `go generate ./...`)
66
* [ ] Code has been formatted (see [here](https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md#code-formatting))

0 commit comments

Comments
 (0)