-
Notifications
You must be signed in to change notification settings - Fork 320
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.
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
[Github] Adding templates for ISSUE & PRs and environment script #53
Conversation
… issues. Adding .github folder with templates for issues and Pull Requests.
@@ -0,0 +1,15 @@ | |||
--- | |||
name: 💡 Feature Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD: Need to agree on (potential) emoji and the name
(this is what is used in Swift Crypto)
.github/ISSUE_TEMPLATE/QUESTION.md
Outdated
@@ -0,0 +1,18 @@ | |||
--- | |||
name: ❓ Support Question |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD: Need to agree on (potential) emoji and the name
(this is what is used in Swift Crypto)
.github/ISSUE_TEMPLATE/REGRESSION.md
Outdated
@@ -0,0 +1,33 @@ | |||
--- | |||
name: 😱 Regression |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD: Need to agree on (potential) emoji and the name
(this is what is used in Swift Crypto)
@@ -0,0 +1,40 @@ | |||
--- | |||
name: 🐛 Bug Report |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD: Need to agree on (potential) emoji and the name
(this is what is used in Swift Crypto)
Thanks for putting together this PR, @Sajjon! Just wanted to note that we're looking at these, but need to think a little more about what kind of guidance we want in each of these places. One Q: Is it possible to have multiple PR templates? |
@natecook1000 Yes, you can create multiple PR templates too So maybe:
|
@Sajjon I'd like to keep things a bit more streamlined, and had too much feedback to give here, so I added a commit. This chops it down to two issue templates, one for bugs and one for feature requests, plus a link to the discussion forums for questions, etc. Pull requests don't seem to provide the nice "chooser" interface, so I made the default one just for regular changes/fixes and added a more in-depth template for feature additions. What do you think of these to start with? Thanks again for getting this ball rolling! |
On second thought, I'm going to merge these and we can iterate on them in place. |
@natecook1000 Cool! Haha what a nasty centipede emoji you found :D The only comment is that you chose to include the Seems like git attributed all changes to you as well, so any/all potential bugs in the bash script will git blame to you 😛. |
Partial fix of #46 + some extra goodies. This PR is a version of apple/swift-crypto#21 updated for this repo, copy pasting my description from that PR in here (we developers are a lazy bunch right?)
Upgrading ISSUE_TEMPLATE from single markdown to 4 option selection: Bug, Regression, Question, Feature Request
Motivation:
Having this template where when user presses
NEW ISSUE
button she has to think about what she's doing might lead to better issues submitted.Modifications:
.github
directory containing four different issues types../Scripts/environment.sh
which puts to together a summary of users environment and copies to pasteboard (asking first). The scripts output looks like this:Result:
New-Issue alternatives
Bug report
With having pasted output generated from
./Scripts/environment.sh
Feature request