From 29b13836f5b4c2b3f5cf0944649604c813d4cd93 Mon Sep 17 00:00:00 2001 From: Rashil Gandhi Date: Fri, 10 Dec 2021 00:38:16 +0530 Subject: [PATCH 1/2] chore: Add issue/PR templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 47 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 27 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 + .github/PULL_REQUEST_TEMPLATE.md | 31 +++++++++++++++ 4 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 0000000000..2ab39dcf2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,47 @@ +--- +name: "Bug Report" +about: "I am facing some problems." +title: '[Bug] ' +labels: "bug" + +--- + + + +## Bug Report + +#### Current Behavior + + +#### Expected Behavior + + +#### Additional context/output + + +#### Possible Solution + + +### System details + +**Windows version:** [e.g. 7, 8, 10] + +**OS architecture:** [e.g. 32bit, 64bit] + +**PowerShell version:** [output of `"$($PSVersionTable.PSVersion)"`] + +**Additional software:** [(optional) e.g. ConEmu, Git] + +#### Scoop Configuration + + +```json +//# Your configuration here +``` diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 0000000000..32faf66b83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,27 @@ +--- +name: "Feature Request" +about: "I have a suggestion (and may want to implement it)!" +title: '[Feature] ' +labels: "enhancement" + +--- + + + +## Feature Request + +#### Is your feature request related to a problem? Please describe. + + +#### Describe the solution you'd like + + +#### Describe alternatives you've considered + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..99d680b0ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: false + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..d142debcb2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ + + + + + + +#### Description + + +#### Motivation and Context + + +Closes #XXXX + +Relates to #XXXX + +#### How Has This Been Tested? + + + + +#### Checklist: + + +- [ ] I have updated the documentation accordingly. +- [ ] I have updated the tests accordingly. From ca6ca1e8b8a34658c31004e755cea5090daf86a4 Mon Sep 17 00:00:00 2001 From: Rashil Gandhi Date: Fri, 10 Dec 2021 00:46:29 +0530 Subject: [PATCH 2/2] chore: Readme tweaks --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8f9bfd2bbb..29d1eda03e 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,14 @@ Scoop is a command-line installer for Windows. ## What does Scoop do? -Scoop installs programs from the command line with a minimal amount of friction. It tries to eliminate things like: - -- Permission popup windows -- GUI wizard-style installers -- Path pollution from installing lots of programs -- Unexpected side-effects from installing and uninstalling programs -- The need to find and install dependencies -- The need to perform extra setup steps to get a working program +Scoop installs programs from the command line with a minimal amount of friction. It: + +- Eliminates permission popup windows +- Hides GUI wizard-style installers +- Prevents PATH pollution from installing lots of programs +- Avoids unexpected side-effects from installing and uninstalling programs +- Finds and installs dependencies automatically +- Performs all the extra setup steps itself to get a working program Scoop is very scriptable, so you can run repeatable setups to get your environment just the way you like, e.g.: