Skip to content

Commit 0d945d1

Browse files
[PR #7916/822fbc74 backport][3.9] Add more information to contributing page (#8072)
**This is a backport of PR #7916 as merged into master (822fbc7).** Co-authored-by: Sam Bull <[email protected]>
1 parent 3ec4fa1 commit 0d945d1

8 files changed

+1137
-65
lines changed

CHANGES/7916.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated :ref:`contributing/Tests coverage <aiohttp-contributing>` section to show how we use ``codecov`` -- by :user:`Dreamsorcerer`.

CHANGES/README.rst

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1-
.. _Adding change notes with your PRs:
1+
.. _Making a pull request:
2+
3+
Making a pull request
4+
=====================
5+
6+
When making a pull request, please include a short summary of the changes
7+
and a reference to any issue tickets that the PR is intended to solve.
8+
All PRs with code changes should include tests. All changes should
9+
include a changelog entry.
210

311
Adding change notes with your PRs
4-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12+
---------------------------------
513

614
It is very important to maintain a log for news of how
715
updating to the new version of the software will affect
816
end-users. This is why we enforce collection of the change
917
fragment files in pull requests as per `Towncrier philosophy`_.
1018

1119
The idea is that when somebody makes a change, they must record
12-
the bits that would affect end-users only including information
20+
the bits that would affect end-users, only including information
1321
that would be useful to them. Then, when the maintainers publish
1422
a new release, they'll automatically use these records to compose
1523
a change log for the respective version. It is important to
@@ -19,7 +27,7 @@ to the end-users most of the time. And so such details should be
1927
recorded in the Git history rather than a changelog.
2028

2129
Alright! So how to add a news fragment?
22-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30+
---------------------------------------
2331

2432
``aiohttp`` uses `towncrier <https://pypi.org/project/towncrier/>`_
2533
for changelog management.
@@ -34,11 +42,14 @@ for the users to understand what it means.
3442
combined with others, it will be a part of the "news digest"
3543
telling the readers **what changed** in a specific version of
3644
the library *since the previous version*. You should also use
37-
reStructuredText syntax for highlighting code (inline or block),
45+
*reStructuredText* syntax for highlighting code (inline or block),
3846
linking parts of the docs or external sites.
39-
If you wish to sign your change, feel free to add ``-- by
40-
:user:`github-username``` at the end (replace ``github-username``
41-
with your own!).
47+
However, you do not need to reference the issue or PR numbers here
48+
as *towncrier* will automatically add a reference to all of the
49+
affected issues when rendering the news file.
50+
If you wish to sign your change, feel free to add
51+
``-- by :user:`github-username``` at the end (replace
52+
``github-username`` with your own!).
4253

4354
Finally, name your file following the convention that Towncrier
4455
understands: it should start with the number of an issue or a
@@ -77,7 +88,7 @@ necessary to make a separate documentation fragment for documentation
7788
changes accompanying the relevant code changes.
7889

7990
Examples for adding changelog entries to your Pull Requests
80-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
-----------------------------------------------------------
8192

8293
File :file:`CHANGES/6045.doc.1.rst`:
8394

Loading
Loading

0 commit comments

Comments
 (0)