Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Issue template to guide user submit good issue #354

Merged
merged 12 commits into from
Nov 4, 2016
13 changes: 13 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Thank you for contibuting to PaddlePaddle. Submitting an issue is a great help for us.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contibuting - > contributing

Both Chinese and English issues are welcome.

Before you submitting the issue, there are several things should be check.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checked

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

去掉 you.
there are several things should be check -> Look over the following criteria before handing your request in.


- [ ] Was there a similar issue submitted and resolved before? You could search issue in github.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

submitted or resolved, in the github

- [ ] Did you go to the search engine for your question?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the seach engines (such as google, baidu, bing etc)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should not list the google, baidu, bing here. ^V^

- [ ] Is my description of issue clear enough for this problem?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is my description of issue clear enough to reproduce this problem?

* If there are some errors occured, we need details about `how do you run your code?`, `what system do you use?`, `Are you using GPU or not?`, etc.
* If you could provide an [asciinema](https://asciinema.org/) record, it will be very great and we could help you more efficiently.
Copy link
Contributor

@gangliao gangliao Nov 4, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it will be very great and we could help you more efficiently.
-> That's awesome ! We could help you solve the problem you identified more quickly.

Copy link
Contributor

@luotao1 luotao1 Nov 4, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's awesome ! We could help you solve the problem more quickly.

- [ ] Is my description of issue use the github markdown correctly?
* Please use correct markdown syntax for code, header, etc.
* You can reference [this page](https://guides.github.com/features/mastering-markdown/) for markdown syntax.