Skip to content

Commit 6c6a2ca

Browse files
rashil2000rashil2000
authored
chore: Add issue/PR templates (#4572)
* chore: Add issue/PR templates * chore: Readme tweaks
1 parent 37a8869 commit 6c6a2ca

File tree

5 files changed

+115
-8
lines changed

5 files changed

+115
-8
lines changed

‎.github/ISSUE_TEMPLATE/Bug_report.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: "Bug Report"
3+
about: "I am facing some problems."
4+
title: '[Bug] '
5+
labels: "bug"
6+
7+
---
8+
9+
<!--
10+
IMPORTANT:
11+
If your problem is related to a specific package, open the issue in the relevant bucket,
12+
not here.
13+
By opening this issue you confirm that you have searched for similar issues/PRs here already.
14+
Failing to do so will most likely result in closing of this issue without any explanation.
15+
Incomplete form details below might also result in closing of the issue.
16+
-->
17+
18+
## Bug Report
19+
20+
#### Current Behavior
21+
<!-- A clear and concise description of the behavior. -->
22+
23+
#### Expected Behavior
24+
<!-- A clear and concise description of what you expected to happen. -->
25+
26+
#### Additional context/output
27+
<!-- Add any other context about the problem here. If applicable, paste terminal output here to help explain. -->
28+
29+
#### Possible Solution
30+
<!--- Only if you have suggestions on a fix for the bug -->
31+
32+
### System details
33+
34+
**Windows version:** [e.g. 7, 8, 10]
35+
36+
**OS architecture:** [e.g. 32bit, 64bit]
37+
38+
**PowerShell version:** [output of `"$($PSVersionTable.PSVersion)"`]
39+
40+
**Additional software:** [(optional) e.g. ConEmu, Git]
41+
42+
#### Scoop Configuration
43+
<!-- Can be found in ~/.config/scoop/config.json -->
44+
45+
```json
46+
//# Your configuration here
47+
```

‎.github/ISSUE_TEMPLATE/Feature_request.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "Feature Request"
3+
about: "I have a suggestion (and may want to implement it)!"
4+
title: '[Feature] '
5+
labels: "enhancement"
6+
7+
---
8+
9+
<!--
10+
IMPORTANT:
11+
If your request is related to a specific package, open the issue in the relevant bucket,
12+
not here.
13+
By opening this issue you confirm that you have searched for similar issues/PRs here already.
14+
Failing to do so will most likely result in closing of this issue without any explanation.
15+
Incomplete form details below might also result in closing of the issue.
16+
-->
17+
18+
## Feature Request
19+
20+
#### Is your feature request related to a problem? Please describe.
21+
<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
22+
23+
#### Describe the solution you'd like
24+
<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
25+
26+
#### Describe alternatives you've considered
27+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

‎.github/ISSUE_TEMPLATE/config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
blank_issues_enabled: false
2+

‎.github/PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- Provide a general summary of your changes in the Title above -->
2+
<!-- To help with semantic versioning the PR title should start with one of the conventional commit types. -->
3+
<!-- The conventional commit types for Semantic PR are: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert -->
4+
5+
<!--
6+
By opening this PR you confirm that you have searched for similar issues/PRs here already.
7+
Failing to do so will most likely result in closing of this PR without any explanation.
8+
It is also mandatory to open a relevant issue for discussion with the maintainers,
9+
before creating any new PR.
10+
-->
11+
12+
#### Description
13+
<!-- Describe your changes in detail -->
14+
15+
#### Motivation and Context
16+
<!-- Why is this change required? What problem does it solve? -->
17+
<!-- If it fixes an open issue, please link to the issue here. -->
18+
Closes #XXXX
19+
<!-- or -->
20+
Relates to #XXXX
21+
22+
#### How Has This Been Tested?
23+
<!-- Please describe in detail how you tested your changes. -->
24+
<!-- Include details of your testing environment, tests ran to see how -->
25+
<!-- your change affects other areas of the code, etc. -->
26+
27+
#### Checklist:
28+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
29+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
30+
- [ ] I have updated the documentation accordingly.
31+
- [ ] I have updated the tests accordingly.

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Scoop is a command-line installer for Windows.
3636

3737
## What does Scoop do?
3838

39-
Scoop installs programs from the command line with a minimal amount of friction. It tries to eliminate things like:
40-
41-
- Permission popup windows
42-
- GUI wizard-style installers
43-
- Path pollution from installing lots of programs
44-
- Unexpected side-effects from installing and uninstalling programs
45-
- The need to find and install dependencies
46-
- The need to perform extra setup steps to get a working program
39+
Scoop installs programs from the command line with a minimal amount of friction. It:
40+
41+
- Eliminates permission popup windows
42+
- Hides GUI wizard-style installers
43+
- Prevents PATH pollution from installing lots of programs
44+
- Avoids unexpected side-effects from installing and uninstalling programs
45+
- Finds and installs dependencies automatically
46+
- Performs all the extra setup steps itself to get a working program
4747

4848
Scoop is very scriptable, so you can run repeatable setups to get your environment just the way you like, e.g.:
4949

0 commit comments

Comments
 (0)