BackTrackZ/scrapy
BackTrackZ/scrapy
1
0
Fork 0
mirror of https://github.com/scrapy/scrapy.git synced 2025-02-24 11:43:41 +00:00
Code Releases Wiki Activity

Minor edits to contributing.rst

Browse Source 
Corrected minor grammatical issues and increased clarity of instructions.
This commit is contained in:
Chris Slothouber 2018-06-01 09:25:34 -04:00 committed by GitHub
parent b364d27247
commit ecdd888ff4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing.rst
View File

@ -48,9 +48,9 @@ guidelines when reporting a new bug.
`Stack Overflow <https://stackoverflow.com/questions/tagged/scrapy>`__ `Stack Overflow <https://stackoverflow.com/questions/tagged/scrapy>`__
(use "scrapy" tag). (use "scrapy" tag).
* check the `open issues`_ to see if it has already been reported. If it has, * check the `open issues`_ to see if the issue has already been reported. If it
don't dismiss the report, but check the ticket history and comments. If you has, don't dismiss the report, but check the ticket history and comments. If
have additional useful information, please leave a comment, or consider you have additional useful information, please leave a comment, or consider
:ref:`sending a pull request <writing-patches>` with a fix. :ref:`sending a pull request <writing-patches>` with a fix.
* search the `scrapy-users`_ list and `Scrapy subreddit`_ to see if it has * search the `scrapy-users`_ list and `Scrapy subreddit`_ to see if it has
@ -122,7 +122,7 @@ conversation in the `Scrapy subreddit`_ to discuss your idea first.
Sometimes there is an existing pull request for the problem you'd like to Sometimes there is an existing pull request for the problem you'd like to
solve, which is stalled for some reason. Often the pull request is in a solve, which is stalled for some reason. Often the pull request is in a
right direction, but changes are requested by Scrapy maintainers, and the right direction, but changes are requested by Scrapy maintainers, and the
original pull request author haven't had time to address them. original pull request author hasn't had time to address them.
In this case consider picking up this pull request: open In this case consider picking up this pull request: open
a new pull request with all commits from the original pull request, as well as a new pull request with all commits from the original pull request, as well as
additional changes to address the raised issues. Doing so helps a lot; it is additional changes to address the raised issues. Doing so helps a lot; it is
@ -143,7 +143,7 @@ instead of "Fix for #411". Complete titles make it easy to skim through
the issue tracker. the issue tracker.
Finally, try to keep aesthetic changes (:pep:`8` compliance, unused imports Finally, try to keep aesthetic changes (:pep:`8` compliance, unused imports
removal, etc) in separate commits than functional changes. This will make pull removal, etc) in separate commits from functional changes. This will make pull
requests easier to review and more likely to get merged. requests easier to review and more likely to get merged.
Coding style Coding style
@ -170,7 +170,7 @@ Documentation policies
**do** provide a docstring, but make sure sphinx documentation uses **do** provide a docstring, but make sure sphinx documentation uses
autodoc_ extension to pull the docstring. For example, the autodoc_ extension to pull the docstring. For example, the
:meth:`ItemLoader.add_value` method should be either :meth:`ItemLoader.add_value` method should be either
documented only in the sphinx documentation (not it a docstring), or documented only in the sphinx documentation (not as a docstring), or
it should have a docstring which is pulled to sphinx documentation using it should have a docstring which is pulled to sphinx documentation using
autodoc_ extension. autodoc_ extension.