From ea1b442e13b4b94162139fd08b2bf40465d619ad Mon Sep 17 00:00:00 2001 From: gorhill Date: Sat, 9 May 2015 15:19:00 -0400 Subject: [PATCH] update --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a6236c..2f1adc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,9 +7,10 @@ 1. When you file an issue, your **responsibility** is to provide **ALL** the exact steps needed for me to reproduce an issue. 1. 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". 1. Every single step, in order, must be provided, with **ALL** relevant details. 1. Screenshots are nice, but use common sense: I can't cut and paste important text information from screenshots. - Regarding screenshots: common sense, common sense, common sense. Too much of a thing can easily end up as noise. -1. Open source quality software comes from contributors carefully **crafting** code: conversely, issues must also be carefully **crafted** by other contributors. +1. 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. 1. If your mindset is that your time is more precious than that of my time, refrain from filing issues.