From 6bf8cee5dabf4043143c6b6b8c125dfa66ac0fd1 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Mon, 18 Oct 2021 16:52:02 +0100 Subject: [PATCH 1/3] (maint) Add PR and Issue templates --- .github/ISSUE_TEMPLATE/AskQuestion.md | 18 +++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/zFeatureRequest.md | 10 ++++ .github/ISSUE_TEMPLATE/zReportIssue.md | 48 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 63 +++++++++++++++++++++++ 5 files changed, 140 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/AskQuestion.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/zFeatureRequest.md create mode 100644 .github/ISSUE_TEMPLATE/zReportIssue.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/AskQuestion.md b/.github/ISSUE_TEMPLATE/AskQuestion.md new file mode 100644 index 0000000..38b8408 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/AskQuestion.md @@ -0,0 +1,18 @@ +--- +name: Ask Question +about: Do you have a question? +--- + +STOP RIGHT HERE - DO NOT CREATE A TICKET FOR A QUESTION ON THIS REPOSITORY + +1. Start with https://docs.chocolatey.org/en-us/troubleshooting (Troubleshooting) and https://docs.chocolatey.org/en-us/faqs (FAQs) to see if your question or issue already has an answer. You can also explore https://docs.chocolatey.org/en-us/ (which are pretty comprehensive, but not always the most searchable). +2. If not found or resolved, please see https://chocolatey.org/support to see what avenues are available to you based on whether you are an open source user or a licensed customer (have a commercial edition). + + +The best routes for getting questions answered when the documentation doesn't serve what you need is the mailing list or in chat: +- email - http://groups.google.com/group/chocolatey +- chat - https://gitter.im/chocolatey/choco + + + +NOTE: Keep in mind we have a [Code of Conduct](./CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ac2e8b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/zFeatureRequest.md b/.github/ISSUE_TEMPLATE/zFeatureRequest.md new file mode 100644 index 0000000..36edd5d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/zFeatureRequest.md @@ -0,0 +1,10 @@ +--- +name: Enhancement / Feature Request +about: Is there additional functionality you would love us to consider? +--- + + diff --git a/.github/ISSUE_TEMPLATE/zReportIssue.md b/.github/ISSUE_TEMPLATE/zReportIssue.md new file mode 100644 index 0000000..29a0fe1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/zReportIssue.md @@ -0,0 +1,48 @@ +--- +name: Report Issue +about: Did you find unexpected behavior? +--- + + + +### What You Are Seeing? + +### What is Expected? + +### How Did You Get This To Happen? (Steps to Reproduce) + +### System Details + +* OS Build (In PowerShell run `[System.Environment]::OSVersion.version.tostring()`): +* Windows PowerShell version (Run: `$PSVersionTable`): +* Chocolatey version (Run `choco --version`): + +### Output Log + + + +
+Full Log Output + +

+ +~~~sh +PLACE LOG CONTENT HERE - WE NEED _ALL_ DETAILED OUTPUT BASED ON THE ABOVE TO BE ABLE TO PROVIDE SUPPORT (YOU WILL FIND THAT IN THE $env:ChocolateyInstall\logs\chocolatey.log between the `=====`) +~~~ + +

+ +
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..cf4a08a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,63 @@ + + +## Description Of Changes + + +## Motivation and Context + + +## Testing + + +## Change Types Made + + +* [ ] Bug fix (non-breaking change) +* [ ] Feature / Enhancement (non-breaking change) +* [ ] Breaking change (fix or feature that could cause existing functionality to change) +* [ ] PowerShell code changes. + +## Related Issue + + +Fixes # + +## Change Checklist + +* [ ] Requires a change to the documentation +* [ ] Documentation has been updated +* [ ] Tests to cover my changes, have been added +* [ ] All new and existing tests passed. +* [ ] PowerShell v2 compatibility checked. + + From dee1c4ccde9bd4d3fb142e73a3d36f25c36d9889 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Thu, 23 Dec 2021 11:16:19 +0000 Subject: [PATCH 2/3] (doc) Add comments on how to write your issue --- .github/ISSUE_TEMPLATE/zReportIssue.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/zReportIssue.md b/.github/ISSUE_TEMPLATE/zReportIssue.md index 29a0fe1..58bf6f0 100644 --- a/.github/ISSUE_TEMPLATE/zReportIssue.md +++ b/.github/ISSUE_TEMPLATE/zReportIssue.md @@ -9,6 +9,12 @@ Ensure you have read over [Submitting Issues](https://github.com/chocolatey/.git Please check to see if your issue already exists with a quick search of the issues. Start with one relevant term and then add if you get too many results. NOTE: Keep in mind we have a [Code Of Conduct](https://github.com/chocolatey/.github/blob/main/CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community. + +Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in the release notes to what it is. + +When writing out the issue details please ensure you are writing it as if you were explaining it to somebody else. +Even if you will be working on and resolving the issue yourself. This helps others to understand the reasons for the +pull request and for it to be searchable in future. --> ### What You Are Seeing? From 8d400db17a0163f28e40d233b12faf08013d343c Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Thu, 23 Dec 2021 11:17:02 +0000 Subject: [PATCH 3/3] (doc) Add comments on creating a gist for logs --- .github/ISSUE_TEMPLATE/zReportIssue.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/zReportIssue.md b/.github/ISSUE_TEMPLATE/zReportIssue.md index 58bf6f0..2afb536 100644 --- a/.github/ISSUE_TEMPLATE/zReportIssue.md +++ b/.github/ISSUE_TEMPLATE/zReportIssue.md @@ -46,7 +46,8 @@ When including the log information, please ensure you have run the command with

~~~sh -PLACE LOG CONTENT HERE - WE NEED _ALL_ DETAILED OUTPUT BASED ON THE ABOVE TO BE ABLE TO PROVIDE SUPPORT (YOU WILL FIND THAT IN THE $env:ChocolateyInstall\logs\chocolatey.log between the `=====`) +IF YOUR LOG CONTENT IS SHORT, PLACE IT HERE - WE NEED _ALL_ DETAILED OUTPUT BASED ON THE ABOVE TO BE ABLE TO PROVIDE SUPPORT (YOU WILL FIND THAT IN THE $env:ChocolateyInstall\logs\chocolatey.log between the `=====`) +IF YOUR LOG CONTENT IS LONG, PLEASE LINK TO A GIST (see https://docs.github.com/en/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) ~~~