Skip to content

Commit ba6dbad

Browse files
committed
Merge pull request scrapy#1926 from redapple/faq-mcve
Reference StackOverflow's "minimal, complete, and verifiable example" guide
2 parents 47bfac1 + 2849ebf commit ba6dbad

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/contributing.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,18 @@ guidelines when reporting a new bug.
4848
if you're not sure if what you're seeing is a bug. You can also ask in the
4949
`#scrapy` IRC channel.
5050

51-
* write complete, reproducible, specific bug reports. The smaller the test
51+
* write **complete, reproducible, specific bug reports**. The smaller the test
5252
case, the better. Remember that other developers won't have your project to
5353
reproduce the bug, so please include all relevant files required to reproduce
54-
it.
54+
it. See for example StackOverflow's guide on creating a
55+
`Minimal, Complete, and Verifiable example`_ exhibiting the issue.
5556

5657
* include the output of ``scrapy version -v`` so developers working on your bug
5758
know exactly which version and platform it occurred on, which is often very
5859
helpful for reproducing it, or knowing if it was already fixed.
5960

61+
.. _Minimal, Complete, and Verifiable example: https://stackoverflow.com/help/mcve
62+
6063
Writing patches
6164
===============
6265

0 commit comments

Comments
 (0)