From bd48d44fa7c88400b118299c6c58d7a02431838f Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 13:46:35 -0700 Subject: [PATCH 01/10] Started work on ISSUES template. Want to have small section to address each issue area: * What happened/what did you expect? * Fix suggestions/reason bug happened. * How to reproduce for other contributors to replicate. * Look at how workflow was affected by issue. * As much detail as they can provide about their setup. --- .github/ISSUES.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/ISSUES.md diff --git a/.github/ISSUES.md b/.github/ISSUES.md new file mode 100644 index 000000000..335b27aa3 --- /dev/null +++ b/.github/ISSUES.md @@ -0,0 +1,10 @@ + + +# Context + + +# Expected Behavior + + +# Actual Behavior + From 932f4c846972867ea5c905474e03d71d0e810809 Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 23:03:33 -0700 Subject: [PATCH 02/10] Finished ISSUES.md * Added section for reproducing bug * Promote step by step reproduction of code, see if anything has been incorrectly done. * Context section for extra details that might be helpful for issue tracking * Final Checklist. Verify bug can be reproduced and details are present. --- .github/ISSUES.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/.github/ISSUES.md b/.github/ISSUES.md index 335b27aa3..f714ca4d3 100644 --- a/.github/ISSUES.md +++ b/.github/ISSUES.md @@ -1,10 +1,39 @@ -# Context +## Context -# Expected Behavior +### Expected Behavior -# Actual Behavior +### Actual Behavior + +## Possible Fix + + + +## Reproduction + +**Steps** +1. Step +2. Step +3. Step + + +# Context + + +## Your Environment + +* Operating System: +* Python Version Used: +* spaCy Version Used: +* Environment Information: + +# Checklist + +- [] Included Explanation of Issue +- [] Can Replicate Issue With Your Provided Steps +- [] Code / error snippet is present +- [] Detailed description of your environment From b66c4c37885c5aea109d11138874201c7314319e Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 23:09:28 -0700 Subject: [PATCH 03/10] Formatted the steps to be in neat ordered list. Minor grammar adjustments. --- .github/ISSUES.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUES.md b/.github/ISSUES.md index f714ca4d3..981669a4b 100644 --- a/.github/ISSUES.md +++ b/.github/ISSUES.md @@ -16,9 +16,12 @@ ## Reproduction **Steps** + 1. Step 2. Step 3. Step +4. Step + # Context @@ -32,7 +35,7 @@ * Environment Information: # Checklist - + - [] Included Explanation of Issue - [] Can Replicate Issue With Your Provided Steps - [] Code / error snippet is present From b2230cd7fb5b0ba0424e02d28f5a1ba064015924 Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 23:15:55 -0700 Subject: [PATCH 04/10] Renamed ISSUES.md to proper template convention of ISSUE_TEMPLATE.md --- .github/ISSUES.md | 42 ------------------------------------------ 1 file changed, 42 deletions(-) delete mode 100644 .github/ISSUES.md diff --git a/.github/ISSUES.md b/.github/ISSUES.md deleted file mode 100644 index 981669a4b..000000000 --- a/.github/ISSUES.md +++ /dev/null @@ -1,42 +0,0 @@ - - -## Context - - -### Expected Behavior - - -### Actual Behavior - - -## Possible Fix - - - -## Reproduction - -**Steps** - -1. Step -2. Step -3. Step -4. Step - - - -# Context - - -## Your Environment - -* Operating System: -* Python Version Used: -* spaCy Version Used: -* Environment Information: - -# Checklist - -- [] Included Explanation of Issue -- [] Can Replicate Issue With Your Provided Steps -- [] Code / error snippet is present -- [] Detailed description of your environment From 071989fd15fa48fdc58febac367b2a28931d6af6 Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 23:15:55 -0700 Subject: [PATCH 05/10] Renamed ISSUES.md to proper template convention of ISSUE_TEMPLATE.md --- .github/ISSUES.md | 42 ------------------------------------------ 1 file changed, 42 deletions(-) delete mode 100644 .github/ISSUES.md diff --git a/.github/ISSUES.md b/.github/ISSUES.md deleted file mode 100644 index 981669a4b..000000000 --- a/.github/ISSUES.md +++ /dev/null @@ -1,42 +0,0 @@ - - -## Context - - -### Expected Behavior - - -### Actual Behavior - - -## Possible Fix - - - -## Reproduction - -**Steps** - -1. Step -2. Step -3. Step -4. Step - - - -# Context - - -## Your Environment - -* Operating System: -* Python Version Used: -* spaCy Version Used: -* Environment Information: - -# Checklist - -- [] Included Explanation of Issue -- [] Can Replicate Issue With Your Provided Steps -- [] Code / error snippet is present -- [] Detailed description of your environment From 1f8826e9061066308537575e4e7064da25e206dd Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Thu, 27 Oct 2016 23:19:18 -0700 Subject: [PATCH 06/10] Tracking proper file: ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 42 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..981669a4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,42 @@ + + +## Context + + +### Expected Behavior + + +### Actual Behavior + + +## Possible Fix + + + +## Reproduction + +**Steps** + +1. Step +2. Step +3. Step +4. Step + + + +# Context + + +## Your Environment + +* Operating System: +* Python Version Used: +* spaCy Version Used: +* Environment Information: + +# Checklist + +- [] Included Explanation of Issue +- [] Can Replicate Issue With Your Provided Steps +- [] Code / error snippet is present +- [] Detailed description of your environment From c2d2b12ef73835ebbfff4c72bd175108400a6264 Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Fri, 28 Oct 2016 23:21:32 -0700 Subject: [PATCH 07/10] Tightening up ISSUE_Template --- .github/ISSUES.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ISSUES.md diff --git a/.github/ISSUES.md b/.github/ISSUES.md new file mode 100644 index 000000000..1f7cf9a99 --- /dev/null +++ b/.github/ISSUES.md @@ -0,0 +1,18 @@ + +## Issue body + + + +## Your Environment + +* Operating System: +* Python Version Used: +* spaCy Version Used: +* Environment Information: + +# Checklist + +- [] Included Explanation of Issue +- [] Can Replicate Issue With Your Provided Steps +- [] Code / error snippet is present +- [] Detailed description of your environment From f0eba7f568a65fa16984c531801d10e644ed5a3a Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Fri, 28 Oct 2016 23:21:50 -0700 Subject: [PATCH 08/10] Tightening up ISSUE_Template --- .github/ISSUES.md | 18 ------------------ .github/ISSUE_TEMPLATE.md | 30 +++--------------------------- 2 files changed, 3 insertions(+), 45 deletions(-) delete mode 100644 .github/ISSUES.md diff --git a/.github/ISSUES.md b/.github/ISSUES.md deleted file mode 100644 index 1f7cf9a99..000000000 --- a/.github/ISSUES.md +++ /dev/null @@ -1,18 +0,0 @@ - -## Issue body - - - -## Your Environment - -* Operating System: -* Python Version Used: -* spaCy Version Used: -* Environment Information: - -# Checklist - -- [] Included Explanation of Issue -- [] Can Replicate Issue With Your Provided Steps -- [] Code / error snippet is present -- [] Detailed description of your environment diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 981669a4b..adfd3d6b8 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,31 +1,7 @@ +## Issue body + -## Context - - -### Expected Behavior - - -### Actual Behavior - - -## Possible Fix - - - -## Reproduction - -**Steps** - -1. Step -2. Step -3. Step -4. Step - - - -# Context - ## Your Environment @@ -39,4 +15,4 @@ - [] Included Explanation of Issue - [] Can Replicate Issue With Your Provided Steps - [] Code / error snippet is present -- [] Detailed description of your environment +- [] Detailed description of your environment \ No newline at end of file From 39a2e993f17745ac41373457fa0ba62c4fc07dcd Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Fri, 28 Oct 2016 23:27:36 -0700 Subject: [PATCH 09/10] Add link to spaCy stackoverflow tag --- .github/ISSUE_TEMPLATE.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index adfd3d6b8..3700f4786 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,10 @@ ## Issue body - + ## Your Environment @@ -8,11 +12,4 @@ * Operating System: * Python Version Used: * spaCy Version Used: -* Environment Information: - -# Checklist - -- [] Included Explanation of Issue -- [] Can Replicate Issue With Your Provided Steps -- [] Code / error snippet is present -- [] Detailed description of your environment \ No newline at end of file +* Environment Information: \ No newline at end of file From 3bc4c6bbab78cc75d29c3ab656b2addf04053b23 Mon Sep 17 00:00:00 2001 From: Sam Bozek Date: Fri, 28 Oct 2016 23:32:11 -0700 Subject: [PATCH 10/10] Minor grammar tweak to environment section --- .github/ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3700f4786..45cec7aff 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,7 +8,7 @@ Has your issue been discussed on stackoverflow? http://stackoverflow.com/questio ## Your Environment - + * Operating System: * Python Version Used: * spaCy Version Used: