[Github] Upgrading ISSUE_TEMPLATE to display 4 alternatives: Bug, Regression, Question or Feature Request

[Sajjon]

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. Replaced ISSUE_TEMPLATE.md with 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).

Result:

New-Issue alternatives

Bug report

With having pasted output generated from ./scripts/environment.sh

Feature request

Kind of like the same as before

[swift-server-bot]

Can one of the admins verify this patch?

[swift-server-bot]

Can one of the admins verify this patch?

[Lukasa]

In general I like this idea. I think we need to extend the pasteboard script to behave sensibly on other platforms as well. Can we add the output of uname -a as well? That will nicely cover getting information about other OSes.

[Sajjon]

@Lukasa I've updated the script a bit, to check if we are on macOS, if so detect which version and Xcode info (might be useful, right?). The script looks like this now:

Script

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)
	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}macOS version: ${macos}\n"
		i="${i}Xcode-select path: '${xcodeselectpath}\n"
		i="${i}Xcode: ${xcodebuild_version} (${xcodebuild_build})"
	fi

	echo "${i}" | pbcopy
	echo "Your pasteboard now contains debug info, paste it on Github"
fi

Output

Hmm for some reason my newlines inside the if does not work... Do you have an idea of what is causing that? (the second line is very long..., contains Xcode info, but newline does not work.)

Swift version: Apple Swift version 5.1.3 (swiftlang-1100.0.282.1 clang-1100.0.33.15)
Target: x86_64-apple-darwin19.3.0\nUnix 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\nmacOS version: 10.15.3\nXcode-select path: '/Applications/Xcode.app/Contents/Developer\nXcode: Xcode 11.3.1 (Build version 11C505)

Issue template

Do you want me to change anything in the markdown templates? Or are they good?

[Lukasa]

I think the templates are all good, and the new script seems fine to me: I have one note about the copyright header and otherwise we're good to go.

[Lukasa]

This comment should be updated to be 2020.

[Sajjon]

fixed, also fixed in script I added yesterday scripts/generate_boilerplate_files_with_gyb.sh

I also updated reference to CONTRIBUTORS.txt, which is now CONTRIBUTORS.md

[Sajjon]

@Lukasa I fixed the comment in license (year + reference to CONTRIBUTORS.txt). I also fixed newline issue in ./script/environment.sh, by adding the magic -e to echo. This is what the script produces:

Swift version: Apple Swift version 5.1.3 (swiftlang-1100.0.282.1 clang-1100.0.33.15)
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.3.1 (Build version 11C505)

[Lukasa]

This LGTM, thanks!

[Lukasa]

@swift-server-bot test this please

[Lukasa]

Looks like some C files got missed. In practice you probably have to change almost every header comment due to the rename of the contributors file.

[Lukasa]

It may be worth doing the header comment fixup in a separate PR just to keep the scope clear.

[Sajjon]

@Lukasa True, good idea, I will split them into two separate PRs. I've updated this to only include Github issue template + new script environments.sh.

So ready to be merged I think?

[Lukasa]

Yup, LGTM. Let's see if the robot agrees.

[Lukasa]

@swift-server-bot test this please

[Sajjon]

For future reference: Regarding discussions of changes of file headers, see #24

[Lukasa]

Ah, we need to update the sanity script. Find the line that does sed -e 's/2018-2019/YEARS/' -e 's/2019/YEARS/' and change it to sed -e 's/2018-2019/YEARS/' -e 's/2019/YEARS/' -e 's/2020/YEARS/'

[Sajjon]

@Lukasa like so? be6e8e9

[Lukasa]

Looks right

[Lukasa]

@swift-server-bot test this please

[Sajjon]

I might be too liberal about my use of git push -f.... but did not wanna spam git history with trivial fixes. I tend to like git commit -amend. So, it ought to be... amended now :D

[Lukasa]

@swift-server-bot test this please

[Lukasa]

🎉