How to file a bug

Jump to bottom Edit New page

kevzlou7979 edited this page Jan 5, 2016 · 4 revisions

#How to file a bug

Go to our issue tracker page on <a href=https://github.com/GwtMaterialDesign/gwt-material/issues">Github.
Search for existing issues using search field at the top of the page. (If the issue exist please dont replicate it, instead just subscribe with that issue).
File a new issue including technical info listed below.
Thanks a ton for helping gwt-material higher quality.

##When filing a new bug please include.

Descriptive Title - use keywords so others can find your bug (avoid duplicates as stated above).
Steps - to triggger the problem that are specific, and repeatable.
What happens - when you follow the steps, and what you expected to happen instead. Include the exact text or any error messages.
Image Screenshot - In order to visualize the issue clearer you can submit a screenshot or animated gif (You can download the software we are using here ScreenToGIF ).
Code Snippets - Please provide a code snippet of your code that causes the bug for later review of reproductivity of the bug.
Did this work in a previous version? - If so, also provide the version that it worked in.
Browsers and OS - please indicate also, where the bug is occuring on each browser and os.
Any errors logged - If any, please copy the error logs from you console.

#What happens after a bug is filed?

##Bug lifecycle

New bug is labeled with 'bug'.
Developers will need to review the bug and will need to reproduce it.
Developers will ping the user who submits the bug about the result.
If there is a bug, developers now will start the debugging session.
If finished , the issue now will labeled as 'ready' and committed directly to master branch (the dev branch of gwt-material).
If Filer agrees that it's fixed - bug is closed.

#Can I help fix a bug? Yes please! But first...

Make sure no one else is already working on it, if the bug has a milestone assigned or is tagged 'ready', then it's already under way. Otherwise, post a comment on the bug to let others know you're starting to work on it.
Read the guidelines for contributing code, pull request guidelines and coding conventions.