mirror of https://github.com/piskelapp/piskel.git
simplify error template
This commit is contained in:
parent
b3c13f1630
commit
aef88c8713
|
@ -1,21 +1,22 @@
|
||||||
To make sure your feature request or bug report is properly handled, follow the guidelines below.
|
|
||||||
|
|
||||||
### Reporting a bug
|
### Reporting a bug
|
||||||
|
|
||||||
When reporting a bug, make sure to include your setup:
|
As much as possible, a bug report should include:
|
||||||
* operating system (Windows/OSX/Linux)
|
* exact steps to reproduce (STRs)
|
||||||
* if website: browser used (name and version if possible)
|
* screenshot of the application after the bug
|
||||||
* if offline application: application version
|
* setup details:
|
||||||
|
* operating system
|
||||||
|
* browser used
|
||||||
|
* (or if offline application: application version)
|
||||||
|
* for crashes / performance issues also include:
|
||||||
|
* number of frames
|
||||||
|
* sprite resolution
|
||||||
|
* session duration
|
||||||
|
|
||||||
If possible try to include exact steps to reproduce (STRs) that can be used by anyone else to reproduce the bug.
|
Feel free to include a .piskel file of the sprite where you faced the bug if it can help to reproduce the problem.
|
||||||
|
|
||||||
When reporting a __crash__ or a __performance issue__ please also include:
|
|
||||||
* the number of frames of the sprite
|
|
||||||
* the resolution of the sprite
|
|
||||||
* the estimated session duration
|
|
||||||
|
|
||||||
### Feature or enhancement request
|
### Feature or enhancement request
|
||||||
|
|
||||||
These don't necessarily need to be as detailed as bug reports, but the more detailed they are, the easier it will be to get started.
|
Great ways to illustrate feature requests are for instance:
|
||||||
|
* mock ups
|
||||||
If the feature request is inspired by a feature from another software, a few screenshots or a GIF are great to illustrate the request.
|
* screenshots / GIF (from another sof)
|
||||||
|
* step by step flow
|
||||||
|
|
Loading…
Reference in New Issue