Skip to content

Commit

Permalink
[ISSUES.md] propose using google colab to reproduce problems (hugging…
Browse files Browse the repository at this point in the history
…face#10270)

* propose using google colab to reproduce problems

* Update ISSUES.md

Co-authored-by: Sylvain Gugger <[email protected]>

Co-authored-by: Sylvain Gugger <[email protected]>
  • Loading branch information
stas00 and sgugger authored Feb 19, 2021
1 parent 4eddc45 commit d27b28d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ You are not required to read the following guidelines before opening an issue. H

Do not dispair if you can't figure it out from the begining, just share what you can and perhaps someone else will be able to help you at the forums.

If your setup involves any custom datasets, the best way to help us reproduce the problem is to create a [Google Colab notebook](https://colab.research.google.com/) that demonstrates the issue and once you verify that the issue still exists, include a link to that notebook in the Issue. Just make sure that you don't copy and paste the location bar url of the open notebook - as this is private and we won't be able to open it. Instead, you need to click on `Share` in the right upper corner of the notebook, select `Get Link` and then copy and paste the public link it will give to you.

7. If you forked off some of this project's code or example applications, please, do not ask us to go into your code repository and figure out what you may have done. The code is already very complex and unless there is an easy way to do a diff and it's a small diff, it won't be possible to find someone with time on their hands to make a lengthy investigation. Albeit, you might find someone at the forums who will be generous to do this for you.

8. Before reporting an issue, first, always try to update your environment to the latest official version of this library. We have no resources to go and debug older revisions, which could easily have bugs that have been fixed in the latest released version.
Expand Down

0 comments on commit d27b28d

Please sign in to comment.