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.
This commit is contained in:
Sam Bozek 2016-10-27 23:03:33 -07:00
parent bd48d44fa7
commit 932f4c8469
1 changed files with 32 additions and 3 deletions

35
.github/ISSUES.md vendored
View File

@ -1,10 +1,39 @@
<!--- Provide Summary of Issue in Title -->
# Context
## Context
<!--- Provide Introduction To the Issue with Necessary Detail, explain why you believe it is a bug -->
# Expected Behavior
### Expected Behavior
<!--- What did you expect to happen? Does it contradict any documentation? -->
# Actual Behavior
### Actual Behavior
<!--- What actually happened? How did it differ from the Expected Behavior? -->
## Possible Fix
<!--- Not necessary, but helpful if fix is suggested or an explanation for the bug's presence is given -->
<!--- If you have put in a pull request reference it here -->
## Reproduction
<!--- Important! Please provide exact steps, and their order required to reproduce the bug -->
**Steps**
1. Step
2. Step
3. Step
<!--- If you have a code snippet that reproduces the bug, insert snippet here -->
# Context
<!--- How has this bug affected you? What was your project goal? -->
## Your Environment
<!-- Include details of the environment you were using -->
* Operating System:
* Python Version Used:
* spaCy Version Used:
* Environment Information:
# Checklist
<!--- Place 'x' into below boxes -->
- [] Included Explanation of Issue
- [] Can Replicate Issue With Your Provided Steps
- [] Code / error snippet is present
- [] Detailed description of your environment