Skip to content
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

Merged
merged 2 commits into from
Mar 5, 2020

Conversation

Sajjon
Copy link
Contributor

@Sajjon Sajjon commented Mar 3, 2020

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:

  1. Adding a .github directory containing four different issues types.
  2. Added new script ./Scripts/environment.sh which puts to together a summary of users environment and copies to pasteboard (asking first). The scripts output looks like this:
Swift version: Apple Swift version 5.2 (swiftlang-1103.0.22 clang-1103.0.22)
Target: x86_64-apple-darwin19.3.0
Unix version: Darwin Sajjode.local 19.3.0 Darwin Kernel Version 19.3.0: Thu Jan  9 20:58:23 PST 2020
 root:xnu-6153.81.5~1/RELEASE_X86_64 x86_64

macOS version: 10.15.3
Xcode-select path: '/Applications/Xcode.app/Contents/Developer
Xcode: Xcode 11.4 (Build version 11N111s)

Result:

New-Issue alternatives

new_issue_options

Bug report

With having pasted output generated from ./Scripts/environment.sh
bug_report

Feature request

feature_request

… issues. Adding .github folder with templates for issues and Pull Requests.
@@ -0,0 +1,15 @@
---
name: 💡 Feature Request
Copy link
Contributor Author

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,18 @@
---
name: ❓ Support Question
Copy link
Contributor Author

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,33 @@
---
name: 😱 Regression
Copy link
Contributor Author

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
Copy link
Contributor Author

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)

@natecook1000
Copy link
Member

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?

@Sajjon
Copy link
Contributor Author

Sajjon commented Mar 5, 2020

@natecook1000 Yes, you can create multiple PR templates too

So maybe:

  • PR template for bug fixes
  • General improvement (typos, code structure/refactoring)
  • New features
  • Meta, for Github/git stuff?

@natecook1000
Copy link
Member

@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!

@natecook1000
Copy link
Member

On second thought, I'm going to merge these and we can iterate on them in place.

@natecook1000 natecook1000 merged commit 7ac45d6 into apple:master Mar 5, 2020
@Sajjon
Copy link
Contributor Author

Sajjon commented Mar 5, 2020

@natecook1000 Cool! Haha what a nasty centipede emoji you found :D

The only comment is that you chose to include the environments.sh script in the repo, but currently not referred to in the template. But yeah might still be beneficial to have around, then we can ask users to give more details at a later point in a discussion, and refer them to the script.

Seems like git attributed all changes to you as well, so any/all potential bugs in the bash script will git blame to you 😛.

@Sajjon Sajjon deleted the cyon_github_templates branch March 5, 2020 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants