Skip to content

Commit d847e65

Browse files
authored
Merge pull request scrapy#2762 from stummjr/add-subreddit-to-docs
Include references to Scrapy subreddit in the docs
2 parents af2963d + 80b160d commit d847e65

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/contributing.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ There are many ways to contribute to Scrapy. Here are some of them:
2222
`Writing patches`_ and `Submitting patches`_ below for details on how to
2323
write and submit a patch.
2424

25-
* Join the `scrapy-users`_ mailing list and share your ideas on how to
25+
* Join the `Scrapy subreddit`_ and share your ideas on how to
2626
improve Scrapy. We're always open to suggestions.
2727

2828
Reporting bugs
@@ -44,9 +44,9 @@ guidelines when reporting a new bug.
4444
don't dismiss the report but check the ticket history and comments, you may
4545
find additional useful information to contribute.
4646

47-
* search the `scrapy-users`_ list to see if it has been discussed there, or
48-
if you're not sure if what you're seeing is a bug. You can also ask in the
49-
`#scrapy` IRC channel.
47+
* search the `scrapy-users`_ list and `Scrapy subreddit`_ to see if it has
48+
been discussed there, or if you're not sure if what you're seeing is a bug.
49+
You can also ask in the `#scrapy` IRC channel.
5050

5151
* write **complete, reproducible, specific bug reports**. The smaller the test
5252
case, the better. Remember that other developers won't have your project to
@@ -98,8 +98,8 @@ patch, but it's always good to have a patch ready to illustrate your arguments
9898
and show that you have put some additional thought into the subject. A good
9999
starting point is to send a pull request on GitHub. It can be simple enough to
100100
illustrate your idea, and leave documentation/tests for later, after the idea
101-
has been validated and proven useful. Alternatively, you can send an email to
102-
`scrapy-users`_ to discuss your idea first.
101+
has been validated and proven useful. Alternatively, you can start a
102+
conversation in the `Scrapy subreddit`_ to discuss your idea first.
103103
When writing GitHub pull requests, try to keep titles short but descriptive.
104104
E.g. For bug #411: "Scrapy hangs if an exception raises in start_requests"
105105
prefer "Fix hanging when exception occurs in start_requests (#411)"
@@ -188,6 +188,7 @@ And their unit-tests are in::
188188

189189
.. _issue tracker: https://github.com/scrapy/scrapy/issues
190190
.. _scrapy-users: https://groups.google.com/forum/#!forum/scrapy-users
191+
.. _Scrapy subreddit: http://reddit.com/r/scrapy
191192
.. _Twisted unit-testing framework: https://twistedmatrix.com/documents/current/core/development/policy/test-standard.html
192193
.. _AUTHORS: https://github.com/scrapy/scrapy/blob/master/AUTHORS
193194
.. _tests/: https://github.com/scrapy/scrapy/tree/master/tests

docs/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Having trouble? We'd like to help!
1313

1414
* Try the :doc:`FAQ <faq>` -- it's got answers to some common questions.
1515
* Looking for specific information? Try the :ref:`genindex` or :ref:`modindex`.
16-
* Ask or search questions in `StackOverflow using the scrapy tag`_,
17-
* Search for information in the `archives of the scrapy-users mailing list`_, or
18-
`post a question`_.
16+
* Ask or search questions in `StackOverflow using the scrapy tag`_.
17+
* Ask or search questions in the `Scrapy subreddit`_.
18+
* Search for questions on the archives of the `scrapy-users mailing list`_.
1919
* Ask a question in the `#scrapy IRC channel`_,
2020
* Report bugs with Scrapy in our `issue tracker`_.
2121

22-
.. _archives of the scrapy-users mailing list: https://groups.google.com/forum/#!forum/scrapy-users
23-
.. _post a question: https://groups.google.com/forum/#!forum/scrapy-users
22+
.. _scrapy-users mailing list: https://groups.google.com/forum/#!forum/scrapy-users
23+
.. _Scrapy subreddit: https://www.reddit.com/r/scrapy/
2424
.. _StackOverflow using the scrapy tag: https://stackoverflow.com/tags/scrapy
2525
.. _#scrapy IRC channel: irc://irc.freenode.net/scrapy
2626
.. _issue tracker: https://github.com/scrapy/scrapy/issues

0 commit comments

Comments
 (0)