This page describes bug reporting and other activities that can be taken using issue tracker.
A GitHub account is required for using issue tracker.
If you found a bug in Simone and you would like to report it, please adhere to the following guidelines:
- Describe bug in most details possible.
- Provide a reduced test case.
- Provide names of failing tests, if that's the case.
- Provide your browser name and version, preferably user agent string.
- Give names of all browser plugins relevant to page rendering, if any.
- Provide any information about unusual configuration of your device, if any. Are you running Wine? Do you have screen reader installed? Those sorts of things.
- If you can provide a patch, make a pull request, and don't create a separate issue.
Reduced test case
Reduced test case is minimal amount of code that is required to reproduce a bug. Using websites like JSFiddle or CodePen, write a proof that bug your reporting really occurs, then attach it to bug report. Although it's not required to do so, it's likely to speed things up when it comes to bug fixing.
Feature requests are welcomed.
Check the roadmap to see if feature you want to request isn't already planned.
Before creating a issue on issue tracker, search existing open issues to check if you're request isn't already requested. If it is, drop your ideas and support into open issue.
There is no promise that any of the requests will be implemented.
There are cases when discussions your changes and ideas first can be beneficial. You can become sure your changes won't get rejected, and the general direction you want to go with your changes does not conflict with this project's vision written down in roadmap.
Please discuss your changes in the following cases:
- When you're planning to contribute a major portion of code.
- When you would like to contribute a new demo.
- When you're planning to add feature from the roadmap. Someone can be already working on it, in which case you could coordinate your efforts.
- When you want to describe your experience with plugin itself and the documentation, and tell about what you've been missing.
- When you're done a custom skin and would like to share the experience and tell about the obstacle you've overcome.
- And especially when you would like to add a feature that is not currently planned.
If you're not the kind of chatty person, you can just go ahead and do a pull request. Be aware however that even well written and thoughtfully tested code might get rejected if it against the general direction written down in roadmap. So it's always best to talk first.