Skip to content

Commit

Permalink
add issue and pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
liu946 committed Nov 30, 2017
1 parent a938aa2 commit ee18c17
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Please ensure your issue adheres to the following guidelines:

- [ ] Search previous issue before making a new one, as yours may be a duplicate.
- [ ] Use a simple _distinguishable_ sentence which can describe your problem.

## *What* is affected by this bug?
Eg. building failed, memory leak, program terminated or analysis mistake.

## *When* does this occur?
Eg. when analyze the sentence "xxx", when the program run for about 4 hours. (Does it possibly occur or occur every time?)

## *Where* on the code does it happen?
Eg. when i call the api xxx and then call xxx the program will crash. (show the process code if needed.)

## *How* do we replicate the issue?
Please be specific as possible. Use dashes (-) or numbers (1.) to create a list of steps

## Your environment information
OS, languages, IDE and it's version, and other related tools, environment variables, the way you insert the code to your project.

## Expected behavior (i.e. solution)
<!-- What should have happened? -->

## Other Comments
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description Changes
Describe your changes in detail

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, tests ran to see how -->
<!--- your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.

0 comments on commit ee18c17

Please sign in to comment.