CodeMirror/uMatrix
1
0
Fork 0
mirror of https://github.com/gorhill/uMatrix.git synced 2024-06-02 10:24:59 +12:00
Code Issues Releases Wiki Activity
uMatrix/CONTRIBUTING.md
Raymond Hill 2b230b85e1 Update CONTRIBUTING.md
2015-07-05 13:08:31 -04:00

1.1 KiB
Raw Blame History

Submitting issues

Must read: How to Report Bugs Effectively.

IMPORTANT

  1. When you file an issue, your responsibility is to provide ALL the exact steps needed for me to reproduce an issue.
  2. Ideally, never should I have to guess how to reproduce an issue.
    • Hence this is why very detailed steps must be very carefully written down the first time the issue is filed.
    • Never assume an important step is "obvious".
  3. Every single step, in order, must be provided, with ALL relevant details.
  4. Screenshots are nice, but use common sense: I can't cut and paste important text information from screenshots.
    • Regarding screenshots: common sense. Too much of a thing can easily end up as noise.
  5. Open source quality software comes from contributors carefully crafting code: conversely, issues must also be carefully crafted.
    • In other words: you benefit from the carefully crafted code, return the favor by carefully crafting issues/bug reports.
  6. If your mindset is that your time is more precious than that of my time, refrain from filing issues.