-
Notifications
You must be signed in to change notification settings - Fork 352
[Github] Adding templates for ISSUE & PRs and environment script #53
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| name: 🐛 Bug Report | ||
| about: Something isn't working as expected | ||
| --- | ||
|
|
||
| <!-- | ||
| Thanks for contributing to the Swift Argument Parser! | ||
|
|
||
| Before you submit your issue, please replace each paragraph | ||
| below with the relevant details for your bug, and complete | ||
| the steps in the checklist by placing an 'x' in each box: | ||
|
|
||
| - [x] I've completed this task | ||
| - [ ] This task isn't completed | ||
| --> | ||
|
|
||
| Replace this paragraph with a short description of the incorrect incorrect behavior. If this is a regression, please note the last version that the behavior was correct in addition to your current version. | ||
|
|
||
| **ArgumentParser version:** `0.1.0` or the `master` branch, for example. | ||
| **Swift version:** Paste the output of `swift --version` here. | ||
|
|
||
| ### Checklist | ||
| - [ ] If possible, I've reproduced the issue using the `master` branch of this package | ||
| - [ ] I've searched for [existing GitHub issues](https://github.com/apple/swift-argument-parser/issues) | ||
|
|
||
| ### Steps to Reproduce | ||
| Replace this paragraph with an explanation of how to reproduce the incorrect behavior. This could include a code listing for a reduced version of your command, or a link to the code that is exhibiting the issue. | ||
|
|
||
| ### Expected behavior | ||
| Describe what you expect to happen. | ||
|
|
||
| ### Actual behavior | ||
| Describe or copy/paste the behavior you observe. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| name: 💡 Feature Request | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) |
||
| about: A suggestion for a new feature | ||
| --- | ||
|
|
||
| <!-- | ||
| Thanks for contributing to the Swift Argument Parser! | ||
|
|
||
| Before you submit your issue, please replace the paragraph | ||
| below with information about your proposed feature. | ||
| --> | ||
|
|
||
| Replace this paragraph with a description of your proposed feature. Code samples that show what's missing, or what new capabilities will be possible, are very helpful! Provide links to existing issues or external references/discussions, if appropriate. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: ❓ Discussion Forum | ||
| url: https://forums.swift.org/c/related-projects/argumentparser/60 | ||
| about: Questions about using Swift Argument Parser? Ask here! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <!-- | ||
| Thanks for contributing to the Swift Argument Parser! | ||
|
|
||
| If this pull request adds new API, please add '?template=new.md' | ||
| to the URL to switch to the appropriate template. | ||
|
|
||
| Before you submit your request, please replace the paragraph | ||
| below with the relevant details, and complete the steps in the | ||
| checklist by placing an 'x' in each box: | ||
|
|
||
| - [x] I've completed this task | ||
| - [ ] This task isn't completed | ||
| --> | ||
|
|
||
| Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate. | ||
|
|
||
| ### Checklist | ||
| - [ ] I've added at least one test that validates that my change is working, if appropriate | ||
| - [ ] I've followed the code style of the rest of the project | ||
| - [ ] I've read the [Contribution Guidelines](CONTRIBUTING.md) | ||
| - [ ] I've updated the documentation if necessary |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!-- | ||
| Thanks for contributing to the Swift Argument Parser! | ||
|
|
||
| Before you submit your request, please replace each paragraph | ||
| below with the relevant details, and complete the steps in the | ||
| checklist by placing an 'x' in each box: | ||
|
|
||
| - [x] I've completed this task | ||
| - [ ] This task isn't completed | ||
| --> | ||
|
|
||
| ### Description | ||
| Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate. | ||
|
|
||
| ### Detailed Design | ||
| Include any additional information about the design here. At minimum, show any new API: | ||
|
|
||
| ```swift | ||
| /// The new feature implemented by this pull request. | ||
| struct NewFeature {} | ||
| ``` | ||
|
|
||
| ### Documentation Plan | ||
| How has the new feature been documented? Have the relevant portions of the guide been updated in addition to symbol-level documentation? | ||
|
|
||
| ### Test Plan | ||
| How is the new feature tested? | ||
|
|
||
| ### Source Impact | ||
| What is the impact of this change on existing users? Does it deprecate or remove any existing API? | ||
|
|
||
| ### Checklist | ||
| - [ ] I've added at least one test that validates that my change is working, if appropriate | ||
| - [ ] I've followed the code style of the rest of the project | ||
| - [ ] I've read the [Contribution Guidelines](CONTRIBUTING.md) | ||
| - [ ] I've updated the documentation if necessary |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| #!/bin/bash | ||
| ##===----------------------------------------------------------------------===## | ||
| ## | ||
| ## This source file is part of the Swift Argument Parser open source project | ||
| ## | ||
| ## Copyright (c) 2020 Apple Inc. and the Swift project authors | ||
| ## Licensed under Apache License v2.0 with Runtime Library Exception | ||
| ## | ||
| ## See https://swift.org/LICENSE.txt for license information | ||
| ## | ||
| ##===----------------------------------------------------------------------===## | ||
|
|
||
| read -p "This will replace your current pasteboard. Continue? [y/n]" -n 1 -r | ||
| echo # (optional) move to a new line | ||
| if [[ $REPLY =~ ^[Yy]$ ]] | ||
| then | ||
| swiftversion=$(swift --version) | ||
| unix_version_name=$(uname -a | tr ";" '\n') | ||
| i="${i}Swift version: ${swiftversion}\n" | ||
| i="${i}Unix version: ${unix_version_name}\n" | ||
|
|
||
| # Check if OS is macOS, if so retrieve which version and Xcode version. | ||
| if [[ "$OSTYPE" == "darwin"* ]]; then | ||
| macos=$(defaults read loginwindow SystemVersionStampAsString | cat -) | ||
| xcodebuild_version=$(/usr/bin/xcodebuild -version | grep Xcode) | ||
| xcodebuild_build=$(/usr/bin/xcodebuild -version | grep Build) | ||
| xcodeselectpath=$(xcode-select -p | cat -) | ||
|
|
||
| i="${i}\nmacOS version: ${macos}\n" | ||
| i="${i}Xcode-select path: '${xcodeselectpath}\n" | ||
| i="${i}Xcode: ${xcodebuild_version} (${xcodebuild_build})" | ||
| fi | ||
|
|
||
| echo -e "${i}" | pbcopy | ||
| echo "Your pasteboard now contains debug info, paste it on Github" | ||
| fi |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)