Skip to content

Commit

Permalink
Update the Scrapy 2.8 release notes up to e71eab6
Browse files Browse the repository at this point in the history
  • Loading branch information
Gallaecio committed Jan 25, 2023
1 parent 539bac0 commit c4df5ef
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ guidelines when you're going to report a new bug.
(use "scrapy" tag).

* check the `open issues`_ to see if the issue has already been reported. If it
has, don't dismiss the report, but check the ticket history and comments. If
has, don't dismiss the report, but check the ticket history and comments. If
you have additional useful information, please leave a comment, or consider
:ref:`sending a pull request <writing-patches>` with a fix.

Expand Down Expand Up @@ -169,7 +169,7 @@ Coding style
Please follow these coding conventions when writing code for inclusion in
Scrapy:

* We use `black <https://black.readthedocs.io/en/stable/>`_ for code formatting.
* We use `black <https://black.readthedocs.io/en/stable/>`_ for code formatting.
There is a hook in the pre-commit config
that will automatically format your code before every commit. You can also
run black manually with ``tox -e black``.
Expand All @@ -179,29 +179,31 @@ Scrapy:
See https://help.github.com/en/github/using-git/setting-your-username-in-git for
setup instructions.

.. _scrapy-pre-commit:

Pre-commit
==========

We use `pre-commit`_ to automatically address simple code issues before every
We use `pre-commit`_ to automatically address simple code issues before every
commit.

.. _pre-commit: https://pre-commit.com/

Before you start writing a patch:
After your create a local clone of your fork of the Scrapy repository:

#. `Install pre-commit <https://pre-commit.com/#installation>`_.

#. On the root of your local clone of the Scrapy repository, run the following
#. On the root of your local clone of the Scrapy repository, run the following
command:

.. code-block:: bash
pre-commit install
Now pre-commit will check your changes every time you create a Git commit. Upon
finding issues, pre-commit aborts your commit, and either fixes those issues
automatically, or only reports them to you. If it fixes those issues
automatically, creating your commit again should succeed. Otherwise, you may
Now pre-commit will check your changes every time you create a Git commit. Upon
finding issues, pre-commit aborts your commit, and either fixes those issues
automatically, or only reports them to you. If it fixes those issues
automatically, creating your commit again should succeed. Otherwise, you may
need to address the corresponding issues manually first.

.. _documentation-policies:
Expand Down
14 changes: 14 additions & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@ Deprecations
New features
~~~~~~~~~~~~

- :setting:`FEED_EXPORT_ENCODING` is now set to ``"utf-8"`` in the
``settings.py`` file that the :command:`startproject` command generates.
With this value, JSON exports won’t force the use of escape sequences for
non-ASCII characters.
(:issue:`5797`, :issue:`5800`)

- The :class:`~scrapy.extensions.memusage.MemoryUsage` extension now logs the
peak memory usage during checks, and the binary unit MiB is now used to
avoid confusion.
Expand All @@ -78,6 +84,10 @@ Bug fixes
websites.
(:issue:`5491`, :issue:`5790`)

- Fixed STARTTLS-based email delivery not working with Twisted 21.2.0 and
better.
(:issue:`5386`, :issue:`5406`)

- Fixed the :meth:`finish_exporting` method of :ref:`item exporters
<topics-exporters>` not being called for empty files.
(:issue:`5537`, :issue:`5758`)
Expand Down Expand Up @@ -145,6 +155,10 @@ Documentation
Quality assurance
~~~~~~~~~~~~~~~~~

- Applied :ref:`black coding style <coding-style>` and introduced
:ref:`pre-commit <scrapy-pre-commit>`.
(:issue:`4654`, :issue:`5734`, :issue:`5734`)

- Switched from :mod:`os.path` to :mod:`pathlib`.
(:issue:`4916`, :issue:`4497`, :issue:`5682`)

Expand Down

0 comments on commit c4df5ef

Please sign in to comment.