GithubHelp home page GithubHelp logo

shd88 / web-bugs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from deeno69/web-bugs

0.0 2.0 0.0 231 KB

A place to report bugs on websites.

Home Page: http://webcompat.com

License: Mozilla Public License 2.0

web-bugs's Introduction

web-bugs

A repo used by the Web Compatibility community to track issues reported via webcompat.com

Screenshot of webcompat.com

###Labels Labels are used for helping to filter bugs into groups but also to track the status of the bug. Here’s what each label means:

  • browser-xyz - The bug exists in xyz browser
  • ios - The bug exists in an iOS browser
  • mobile - The bug exists on mobile devices
  • os-android - The bug exists in an Android browser
  • status-contactready - Issue has been analyzed and is ready for someone to contact the site
  • status-duplicate - Issue is the same as an already-reported issue
  • status-fixed - Issue is fixed
  • status-invalid - Issue is not a web compatibility issue
  • status-needscontact - The web site with the issue needs to be contacted
  • status-needsdiagnosis - Issue needs further analysis to find the cause
  • status-needsinfo - Issue needs more information
  • status-needstriage - The issue needs to be screened and prioritized
  • status-sitewait - The web site with the issue has been contacted
  • status-wontfix - The issue will not be fixed
  • status-worksforme - The issue can't be reproduced
  • windows - The bug exists in a Windows browser

###Best practices

If you’re using Webcompat.com already, you’re probably pretty awesome. So why do you need to read this? Well from experience we know a few tricks that make the web compatibility process go even smoother. And who doesn’t want to learn sweet new tricks?

####Filing web compatibility bugs

  • Fill the bug report form out completely. The more information you provide the easier it is for volunteers to understand the problem
  • List any other browsers you tested the site with
  • Try to avoid reporting issues for sites that are broken in all browsers. We like to focus our energy on sites that work in one browser but not others
  • If you feel comfortable dig in and analyze the bug as well

####Analyzing web compatibility bugs

  • Confirm that you can reproduce the error. Ideally you should use a clean browser profile. See this tutorial for Firefox.
  • Set any related labels - if the bug appears on Chrome for Android, set the “browser-chrome” and “os-android” labels
  • Provide details on which piece of code is broken
  • List out any relevant error codes
  • If possible, suggest a way to fix the code to work in all browsers
  • Once complete, add the “status-contactready” label
  • If you feel comfortable find a contact at the site and reach out

####Contacting the site/company

  • Once a bug is set to “status-contactready” the site can be contacted
  • After you have attempted to make contact remove the "status-contactready" label and add "status-sitewait" so others don't attempt to contact
  • Leave details about who you are contacting, example “Joe Webmaster - Developer at Company X”
  • Be careful not to leak any private information like email addresses, phone numbers
  • If you post somewhere public like twitter, include the link to the tweet in the bug for easy tracking
  • If you receive an issue tracking number from the site include this in the bug
  • When you receive responses, leave some information on the bug (paraphrasing is fine)
  • If no response is received after a week or two, try another method. After a month or three contact attempts we can stop and revisit it later

web-bugs's People

Contributors

dshgna avatar karlcow avatar swarnava avatar tagawa avatar techchic avatar zcorpan avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.