From 9bdbe7d6d02e7f61cf7c303ac1c480a30a1bc74a Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 13:10:26 -0800 Subject: [PATCH 01/12] Add first draft Issue template --- ISSUE_TEMPLATE.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..7a013bf39 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,41 @@ +### Flow + +* [ ] Bug + * [ ] Can you reproduce the problem in [safe mode](https://atom.io/docs/latest/hacking-atom-debugging#check-if-the-problem-shows-up-in-safe-mode)? + * [ ] Did you check the [debugging guide](https://atom.io/docs/latest/hacking-atom-debugging)? + * [ ] Did you check the [FAQs on Discuss](https://discuss.atom.io/c/faq)? + * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? + * [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) to see if it is already reported? + * For more information on how to write a good bug report [look at the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). +* [ ] Enhancement + * [ ] Are you running the [latest version of Atom](https://atom.io/docs/latest/hacking-atom-debugging#update-to-the-latest-version)? + * [ ] Did you check to see if [a package](https://atom.io/packages) already offers the feature? + * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? + * [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) to see if it is already requested? + * For more recommendations on how to write a good enhancement suggestion [see the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion). + +### Description + +[Description of the bug or feature] + +### Repro Steps + +1. [First Step] +2. [Second Step] +3. [and so on...] + +**Expected:** [What you expected to happen] +**Actual:** [What actually happened] + +### Versions + +You can get this information from executing `atom --version` and `apm --version` at the command line: + +* **Atom:** x.y.z +* **Electron:** x.y.z +* **OS:** OS x.y.z +* **APM** + * apm x.y.z + * npm x.y.z + * python x.y.z + * git x.y.z From dca727e3afd7808b2592f746151a03fb72e41d74 Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 13:10:42 -0800 Subject: [PATCH 02/12] Add more version information to --version arg --- src/browser/main.coffee | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/browser/main.coffee b/src/browser/main.coffee index 20f5bb046..0fd5cc59d 100644 --- a/src/browser/main.coffee +++ b/src/browser/main.coffee @@ -83,6 +83,12 @@ setupCompileCache = -> compileCache = require('../compile-cache') compileCache.setAtomHomeDirectory(process.env.ATOM_HOME) +fullVersion = -> + process.stdout.write("Atom : #{app.getVersion()}\n") + process.stdout.write("Electron: #{process.versions.electron}\n") + process.stdout.write("Chrome : #{process.versions.chrome}\n") + process.stdout.write("Node : #{process.versions.node}\n") + parseCommandLine = -> version = app.getVersion() options = yargs(process.argv[1..]).wrap(100) @@ -118,7 +124,7 @@ parseCommandLine = -> options.boolean('portable').describe('portable', 'Set portable mode. Copies the ~/.atom folder to be a sibling of the installed Atom location if a .atom folder is not already there.') options.alias('t', 'test').boolean('t').describe('t', 'Run the specified specs and exit with error code on failures.') options.string('timeout').describe('timeout', 'When in test mode, waits until the specified time (in minutes) and kills the process (exit code: 130).') - options.alias('v', 'version').boolean('v').describe('v', 'Print the version.') + options.alias('v', 'version').boolean('v').describe('v', 'Print the version information.') options.alias('w', 'wait').boolean('w').describe('w', 'Wait for window to be closed before returning.') options.string('socket-path') options.string('user-data-dir') @@ -131,7 +137,7 @@ parseCommandLine = -> process.exit(0) if args.version - process.stdout.write("#{version}\n") + fullVersion() process.exit(0) executedFrom = args['executed-from']?.toString() ? process.cwd() From c9a335df7ad57397a22c13f2964854116447e48f Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 13:27:30 -0800 Subject: [PATCH 03/12] Exclude atom/electron from the search templates --- ISSUE_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 7a013bf39..d021bb831 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -5,13 +5,13 @@ * [ ] Did you check the [debugging guide](https://atom.io/docs/latest/hacking-atom-debugging)? * [ ] Did you check the [FAQs on Discuss](https://discuss.atom.io/c/faq)? * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? - * [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) to see if it is already reported? + * [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if it is already reported? * For more information on how to write a good bug report [look at the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). * [ ] Enhancement * [ ] Are you running the [latest version of Atom](https://atom.io/docs/latest/hacking-atom-debugging#update-to-the-latest-version)? * [ ] Did you check to see if [a package](https://atom.io/packages) already offers the feature? * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? - * [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) to see if it is already requested? + * [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if it is already requested? * For more recommendations on how to write a good enhancement suggestion [see the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion). ### Description From 641a721ff613951e3e9e11596838b16120b9842a Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 13:40:49 -0800 Subject: [PATCH 04/12] Add a break between expected and actual --- ISSUE_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index d021bb831..7f1eefcc9 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -25,6 +25,7 @@ 3. [and so on...] **Expected:** [What you expected to happen] + **Actual:** [What actually happened] ### Versions From e16318374507dcd378695be84dba27496320c96c Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 13:59:13 -0800 Subject: [PATCH 05/12] Repro Steps -> Steps to Reproduce --- ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 7f1eefcc9..5b0337ad2 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -18,7 +18,7 @@ [Description of the bug or feature] -### Repro Steps +### Steps to Reproduce 1. [First Step] 2. [Second Step] From cc8a0ccbf7b757132854c156524a150c49dddbb1 Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 14:30:28 -0800 Subject: [PATCH 06/12] Squish all the printing into one call --- src/browser/main.coffee | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/browser/main.coffee b/src/browser/main.coffee index 0fd5cc59d..0adb08e0b 100644 --- a/src/browser/main.coffee +++ b/src/browser/main.coffee @@ -84,10 +84,13 @@ setupCompileCache = -> compileCache.setAtomHomeDirectory(process.env.ATOM_HOME) fullVersion = -> - process.stdout.write("Atom : #{app.getVersion()}\n") - process.stdout.write("Electron: #{process.versions.electron}\n") - process.stdout.write("Chrome : #{process.versions.chrome}\n") - process.stdout.write("Node : #{process.versions.node}\n") + process.stdout.write """ + Atom : #{app.getVersion()} + Electron: #{process.versions.electron} + Chrome : #{process.versions.chrome} + Node : #{process.versions.node} + + """ parseCommandLine = -> version = app.getVersion() From e514de3eb2bb961822a397e89284fb1c183f2b6c Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 14:40:18 -0800 Subject: [PATCH 07/12] Remove versions template --- ISSUE_TEMPLATE.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 5b0337ad2..94df389b9 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -30,13 +30,4 @@ ### Versions -You can get this information from executing `atom --version` and `apm --version` at the command line: - -* **Atom:** x.y.z -* **Electron:** x.y.z -* **OS:** OS x.y.z -* **APM** - * apm x.y.z - * npm x.y.z - * python x.y.z - * git x.y.z +You can get this information from executing `atom --version` and `apm --version` at the command line. From 6202409d494d74d1d5d4373bd935e90732d18d1c Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 14:56:40 -0800 Subject: [PATCH 08/12] fullVersion -> writeFullVersion --- src/browser/main.coffee | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/browser/main.coffee b/src/browser/main.coffee index 0adb08e0b..54c06db14 100644 --- a/src/browser/main.coffee +++ b/src/browser/main.coffee @@ -83,7 +83,7 @@ setupCompileCache = -> compileCache = require('../compile-cache') compileCache.setAtomHomeDirectory(process.env.ATOM_HOME) -fullVersion = -> +writeFullVersion = -> process.stdout.write """ Atom : #{app.getVersion()} Electron: #{process.versions.electron} @@ -140,7 +140,7 @@ parseCommandLine = -> process.exit(0) if args.version - fullVersion() + writeFullVersion() process.exit(0) executedFrom = args['executed-from']?.toString() ? process.cwd() From 4e141aaaa9886bb866f7499f9c4eecf9207f7409 Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 15:01:55 -0800 Subject: [PATCH 09/12] Make the flow section less verbose --- ISSUE_TEMPLATE.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 94df389b9..596f4ecea 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,18 +1,13 @@ ### Flow -* [ ] Bug - * [ ] Can you reproduce the problem in [safe mode](https://atom.io/docs/latest/hacking-atom-debugging#check-if-the-problem-shows-up-in-safe-mode)? - * [ ] Did you check the [debugging guide](https://atom.io/docs/latest/hacking-atom-debugging)? - * [ ] Did you check the [FAQs on Discuss](https://discuss.atom.io/c/faq)? - * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? - * [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if it is already reported? - * For more information on how to write a good bug report [look at the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). -* [ ] Enhancement - * [ ] Are you running the [latest version of Atom](https://atom.io/docs/latest/hacking-atom-debugging#update-to-the-latest-version)? - * [ ] Did you check to see if [a package](https://atom.io/packages) already offers the feature? - * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? - * [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if it is already requested? - * For more recommendations on how to write a good enhancement suggestion [see the CONTRIBUTING guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion). +* [ ] Can you reproduce the problem in [safe mode](https://atom.io/docs/latest/hacking-atom-debugging#check-if-the-problem-shows-up-in-safe-mode)? +* [ ] Are you running the [latest version of Atom](https://atom.io/docs/latest/hacking-atom-debugging#update-to-the-latest-version)? +* [ ] Did you check the [debugging guide](https://atom.io/docs/latest/hacking-atom-debugging)? +* [ ] Did you check the [FAQs on Discuss](https://discuss.atom.io/c/faq)? +* [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? +* [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if your bug or enhancement is already reported? + +For more information on how to write a good [bug report](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) or [enhancement request](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion), see the `CONTRIBUTING` guide ### Description From cfe63f8be222c56b8a45ebda27bcda41b3f6cf0d Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 16:21:21 -0800 Subject: [PATCH 10/12] Flow -> Prerequisites --- ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 596f4ecea..aa8e3e1db 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -### Flow +### Prerequisites * [ ] Can you reproduce the problem in [safe mode](https://atom.io/docs/latest/hacking-atom-debugging#check-if-the-problem-shows-up-in-safe-mode)? * [ ] Are you running the [latest version of Atom](https://atom.io/docs/latest/hacking-atom-debugging#update-to-the-latest-version)? From e8966ad4c6ab6cd96a89b34b4ec7c573136b89e3 Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Wed, 17 Feb 2016 17:29:52 -0800 Subject: [PATCH 11/12] Add missing period --- ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index aa8e3e1db..03aae4a4c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -7,7 +7,7 @@ * [ ] Are you reporting to the [correct repository](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#atom-and-packages)? * [ ] Did you [perform a cursory search](https://github.com/issues?q=is%3Aissue+user%3Aatom+-repo%3Aatom%2Felectron) to see if your bug or enhancement is already reported? -For more information on how to write a good [bug report](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) or [enhancement request](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion), see the `CONTRIBUTING` guide +For more information on how to write a good [bug report](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) or [enhancement request](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion), see the `CONTRIBUTING` guide. ### Description From f4c48b0977f5741f1b2a1be376039355c4d36425 Mon Sep 17 00:00:00 2001 From: Lee Dohm Date: Thu, 18 Feb 2016 10:57:11 -0800 Subject: [PATCH 12/12] Add 'behavior' to make the fields clearer --- ISSUE_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 03aae4a4c..73ff2f50d 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -19,9 +19,9 @@ For more information on how to write a good [bug report](https://github.com/atom 2. [Second Step] 3. [and so on...] -**Expected:** [What you expected to happen] +**Expected behavior:** [What you expected to happen] -**Actual:** [What actually happened] +**Actual behavior:** [What actually happened] ### Versions