Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
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)

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.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
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)

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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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!
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/NEW.md
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
36 changes: 36 additions & 0 deletions Scripts/environment.sh
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