Skip to content

Take advantage of PR and multiple issue templates #1320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2018
Merged

Take advantage of PR and multiple issue templates #1320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/Bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: Bug report 🐛
about: Report errors or unexpected behavior 🤔

---

<!--

BEFORE SUBMITTING A NEW ISSUE, PLEASE READ THE FAQ!!
Expand All @@ -6,6 +12,10 @@ https://github.com/PowerShell/vscode-powershell/wiki/FAQ
If your issue is not addressed by the FAQ, please
fill in the following details so that we can help you!

IMPORTANT: you can generate a bug report directly from the
PowerShell extension in Visual Studio Code by selecting
"PowerShell: Upload Bug Report to GitHub" from the command palette.

The more repro details you can provide, along with a zip
of the log files from your session, the better the chances
are for a quick resolution.
Expand Down
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature request/idea 🚀
about: Suggest a new feature or improvement (this does not mean you have to implement it)

---

**Summary of the new feature**

A clear and concise description of what the problem is that the new feature would solve.
Try formulating it in user story style (if applicable):
'As a user I want X so that Y.' with X being the being the action and Y being the value of the action.

**Proposed technical implementation details (optional)**

A clear and concise description of what you want to happen.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/Support_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Support Question ❓
about: If you have a question, you can try asking in the VSCode channel of the international PowerShell Slack channel first. You can also try Gitter chat for vscode-powershell.

---

* Slack Community Chat: https://powershell.slack.com (you can sign-up at http://slack.poshcode.org/ for an invite)
* Gitter Chat: https://gitter.im/PowerShell/vscode-powershell
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/Syntax_Colorization_Report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Editor Syntax Colorization bug report ❓
about: Editor syntax colorization bugs are tracked in a separate GitHub repo.

---

* Please submit editor syntax colorization issues with PowerShell scripts
to the [EditorSyntax](https://github.com/powershell/editorSyntax/issues) repo on GitHub.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## PR Summary

<!-- summarize your PR between here and the checklist -->

## PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an `x` between the square brackets.
Please mark anything not applicable to this PR `NA`.

- [ ] PR has a meaningful title
- [ ] Summarized changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No checks for licensing headers or if tests were added or if the change is breaking similar to the PSCore repo? (yes, I realize PSSA hasn't updated to the latest PR template either)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have just a few vscode-powershell tests. And many of the features we add wind up being hard to test as "unit" tests. Probably need a UI automation type of test. While breaking changes are possible I think they're much less likely on the extension side. Now PSES is a different matter. What's the "licensing headers" issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW I'm somewhat hesitant to add a PR template because we're in the mode of encouraging more contributors so we want a low barrier to entry. But I think we can add one that isn't too onerous. Mainly I wanted @tylerl0706 automatically added as a reviewer of each PR. :-)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @bergmeister is talking about requiring the Microsoft copyright header to new files.

- [ ] This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix `WIP:` to the beginning of the title and remove the prefix when the PR is ready

@tylerl0706