Skip to content

Commit dd73d6a

Browse files
HonkingGooseHonkingGoose
committed
chore: improve GitHub templates
- Create pull request template - Prevent contributors opening empty issues - Remove old ISSUE_TEMPLATE file that's no longer needed - Redirect unwanted bug reports with config.yml file - Remove wall of text in templates that used to redirect unwanted stuff - Use clearer headings for operating system/browser section - Use clear language - Capitalize noun Git where it's used - Fix whitespace and file formatting
1 parent fff1673 commit dd73d6a

File tree

5 files changed

+59
-45
lines changed

5 files changed

+59
-45
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Problems/questions/bugs about Git program
4+
url: https://git-scm.com/community
5+
about: Start a discussion on the community mailing list.
6+
7+
- name: Problems about Git for Windows program
8+
url: https://github.com/git-for-windows/git/issues
9+
about: Report problems with the Git for Windows program.
10+
11+
- name: Git documentation (man/help pages)
12+
url: https://git-scm.com/community
13+
about: Git documentation (anything with a URL starting with https://git-scm.com/docs).
14+
15+
- name: Pro Git 2 book content
16+
url: https://github.com/progit/progit2/issues
17+
about: Report problems with the ProGit 2 book content.

‎.github/ISSUE_TEMPLATE/downloads.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,32 @@
11
---
2-
name: 'Downloads on git-scm not working'
3-
about: 'If you are experiencing problems downloading git from git-scm.com'
2+
name: "Downloads on git-scm not working"
3+
about: "If you are experiencing problems downloading Git from git-scm.com"
44
---
55

6-
<!---
7-
Please follow the instructions below.
8-
An issue properly explained is solved much faster!
9-
10-
* If you are experiencing problems/questions/bugs with git itself, start a discussion on the [community mailing list](https://git-scm.com/community).
11-
* If you are experiencing problems on your git for windows program, please open an issue at [git-for-windows/git](https://github.com/git-for-windows/git).
12-
* Please open Git documentation (a.k.a. man/help pages, i.e. anything with a URL starting with `https://git-scm.com/docs`) specific issues with the [community](https://git-scm.com/community),
13-
* Please open Pro Git book contents issues (i.e. anything with a URL starting with `https://git-scm.com/book` or its PDF versions) at [progit/progit2](https://github.com/progit/progit2/issues).
14-
6+
<!---
7+
Please follow the instructions below.
8+
An issue properly explained is solved much faster!
159
-->
1610

17-
<!--- Provide a brief summary of the issue in the title above -->
11+
<!--- Provide a brief summary of the issue in the issue title -->
1812

1913
### Which download is failing?
20-
<!--- Tell us in which page and version is the download broken -->
14+
15+
<!--- Tell us in which page and version is the download broken -->
2116

2217
### Problem
23-
<!--- Tell us the problem as clear as possible -->
2418

25-
### Context
19+
<!--- Explain the problem clearly -->
20+
21+
### Operating system and browser
22+
2623
<!--- Which operating system and browser are you using? -->
27-
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
2824

29-
### Steps to Reproduce
25+
### Steps to reproduce
26+
3027
<!--- Provide a detailed list of steps. -->
31-
<!--- In the rare cases where this is infeasible, we will also accept a detailed set of instructions. -->
28+
<!--- In the rare cases where this is not possible, we will accept a detailed set of instructions. -->
3229

3330
### Other details
34-
<!--- Include as many relevant details you may find relevant -->
3531

32+
<!--- Include as many relevant details you may find relevant -->

‎.github/ISSUE_TEMPLATE/ui.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
---
2-
name: 'git-scm UI broken'
3-
about: 'git-scm.com UI is not working'
2+
name: "git-scm user interface broken"
3+
about: "git-scm.com user interface is not working"
44
---
55

6-
<!---
7-
Please follow the instructions below.
8-
An issue properly explained is solved much faster!
9-
10-
* If you are experiencing problems/questions/bugs with git itself, start a discussion on the [community mailing list](https://git-scm.com/community).
11-
* If you are experiencing problems on your git for windows program, please open an issue at [git-for-windows/git](https://github.com/git-for-windows/git).
12-
* Please open Git documentation (a.k.a. man/help pages, i.e. anything with a URL starting with `https://git-scm.com/docs`) specific issues with the [community](https://git-scm.com/community),
13-
* Please open Pro Git book contents issues (i.e. anything with a URL starting with `https://git-scm.com/book` or its PDF versions) at [progit/progit2](https://github.com/progit/progit2/issues).
6+
<!---
7+
Please follow the instructions below.
8+
An issue properly explained is solved much faster!
149
10+
Only report problems with the git-scm.com site's JavaScript, CSS or content that doesn't seem to be doing its job correctly!
1511
-->
1612

17-
<!--- Provide a brief summary of the issue in the title above -->
13+
<!--- Provide a brief summary of the issue in the issue title -->
1814

1915
### URL for broken page
20-
<!--- Tell us in which page is the website broken -->
16+
17+
<!--- Give us the link to the broken page -->
2118

2219
### Problem
23-
<!--- Tell us the problem as clear as possible -->
2420

25-
### Context
21+
<!--- Explain the problem clearly -->
22+
23+
### Operating system and browser
24+
2625
<!--- Which operating system and browser are you using? -->
27-
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
2826

29-
### Steps to Reproduce
27+
### Steps to reproduce
28+
3029
<!--- Provide a detailed list of steps. -->
31-
<!--- In the rare cases where this is infeasible, we will also accept a detailed set of instructions. -->
30+
<!--- In the rare cases where this is not possible, we will accept a detailed set of instructions. -->
3231

3332
### Other details
34-
<!--- Include as many relevant details you may find relevant -->
3533

34+
<!--- Include as many relevant details you may find relevant -->

‎.github/pull_request_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Changes
2+
3+
<!-- List the changes this PR makes. -->
4+
5+
-
6+
7+
## Context
8+
9+
<!-- Explain why you're making these changes. -->

0 commit comments

Comments
 (0)