From 2849ebf4c6e9ecfa95dfc5543158f5c1a46256e3 Mon Sep 17 00:00:00 2001 From: Paul Tremberth Date: Tue, 12 Apr 2016 14:07:33 +0200 Subject: [PATCH] Reference StackOverflow's "minimal, complete, and verifiable example" guide --- docs/contributing.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a21af3ff4..f1f4c63ae 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -48,15 +48,18 @@ guidelines when reporting a new bug. if you're not sure if what you're seeing is a bug. You can also ask in the `#scrapy` IRC channel. -* write complete, reproducible, specific bug reports. The smaller the test +* write **complete, reproducible, specific bug reports**. The smaller the test case, the better. Remember that other developers won't have your project to reproduce the bug, so please include all relevant files required to reproduce - it. + it. See for example StackOverflow's guide on creating a + `Minimal, Complete, and Verifiable example`_ exhibiting the issue. * include the output of ``scrapy version -v`` so developers working on your bug know exactly which version and platform it occurred on, which is often very helpful for reproducing it, or knowing if it was already fixed. +.. _Minimal, Complete, and Verifiable example: https://stackoverflow.com/help/mcve + Writing patches ===============