-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add more information to contributing page #7916
Merged
Merged
Changes from 41 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
d155e00
Add more information to contributing page.
Dreamsorcerer 1abf034
Create 7916.doc
Dreamsorcerer 616576b
Update docs/contributing.rst
Dreamsorcerer 1b67ffa
Update contributing.rst
Dreamsorcerer 4677136
Update 7916.doc
Dreamsorcerer 37a5a3a
Update spelling_wordlist.txt
Dreamsorcerer d4f956b
Update docs/contributing.rst
Dreamsorcerer aa58588
Include changes readme
Dreamsorcerer a2a6ed9
Update README.rst
Dreamsorcerer c8d8887
Update contributing.rst
Dreamsorcerer d625b3d
Update spelling_wordlist.txt
Dreamsorcerer 8c3d928
Update contributing.rst
Dreamsorcerer 14acacf
Update README.rst
Dreamsorcerer c761044
Update README.rst
Dreamsorcerer 7639249
Update README.rst
Dreamsorcerer 91ac91c
Update README.rst
Dreamsorcerer cb62097
Update CHANGES/7916.doc
Dreamsorcerer 9089797
Update README.rst
Dreamsorcerer d96b18b
Update contributing.rst
Dreamsorcerer 96b5c39
Create contributing-cov-comment.svg
Dreamsorcerer a733f0d
Update contributing.rst
Dreamsorcerer 19efe3a
Delete docs/contributing-cov-comment.png
Dreamsorcerer 1c2624b
Create contributing-cov-header.svg
Dreamsorcerer a2104ba
Update contributing.rst
Dreamsorcerer 8760165
Delete docs/contributing-cov-header.png
Dreamsorcerer a2123d0
Update contributing.rst
Dreamsorcerer fe93ad4
Update contributing.rst
Dreamsorcerer d82e65e
Update README.rst
Dreamsorcerer 7fe88d2
Update docs/contributing.rst
Dreamsorcerer 2c5ab46
Header
Dreamsorcerer 0aadbf2
Update contributing.rst
Dreamsorcerer 1cbad49
Code coverage
Dreamsorcerer 1bc8110
Update 7916.doc
Dreamsorcerer f4b72b2
.rst
Dreamsorcerer 11fa848
Tip
Dreamsorcerer d8472a2
Create contributing-cov-partial.svg
Dreamsorcerer 624905c
Create contributing-cov-miss.svg
Dreamsorcerer 191b4c5
Delete docs/contributing-cov-miss.png
Dreamsorcerer aeb4018
Delete docs/contributing-cov-partial.png
Dreamsorcerer 8284d87
Update contributing.rst
Dreamsorcerer 1310a6d
Merge branch 'master' into docs-contributing
Dreamsorcerer c949f75
Update docs/contributing.rst
Dreamsorcerer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Updated :ref:`contributing/Tests coverage <aiohttp-contributing>` section to show how we use ``codecov`` -- by :user:`Dreamsorcerer`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,23 @@ | ||
.. _Adding change notes with your PRs: | ||
.. _Making a pull request: | ||
|
||
Making a pull request | ||
===================== | ||
|
||
When making a pull request, please include a short summary of the changes | ||
and a reference to any issue tickets that the PR is intended to solve. | ||
All PRs with code changes should include tests. All changes should | ||
include a changelog entry. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, I missed that this now refers to tests that are not related to the https://github.com/aio-libs/aiohttp/tree/master/CHANGES#readme directory at all. |
||
|
||
Adding change notes with your PRs | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Dreamsorcerer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--------------------------------- | ||
|
||
It is very important to maintain a log for news of how | ||
updating to the new version of the software will affect | ||
end-users. This is why we enforce collection of the change | ||
fragment files in pull requests as per `Towncrier philosophy`_. | ||
|
||
The idea is that when somebody makes a change, they must record | ||
the bits that would affect end-users only including information | ||
the bits that would affect end-users, only including information | ||
that would be useful to them. Then, when the maintainers publish | ||
a new release, they'll automatically use these records to compose | ||
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 | |
recorded in the Git history rather than a changelog. | ||
|
||
Alright! So how to add a news fragment? | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
--------------------------------------- | ||
Dreamsorcerer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
``aiohttp`` uses `towncrier <https://pypi.org/project/towncrier/>`_ | ||
for changelog management. | ||
|
@@ -34,11 +42,14 @@ for the users to understand what it means. | |
combined with others, it will be a part of the "news digest" | ||
telling the readers **what changed** in a specific version of | ||
the library *since the previous version*. You should also use | ||
reStructuredText syntax for highlighting code (inline or block), | ||
*reStructuredText* syntax for highlighting code (inline or block), | ||
linking parts of the docs or external sites. | ||
If you wish to sign your change, feel free to add ``-- by | ||
:user:`github-username``` at the end (replace ``github-username`` | ||
with your own!). | ||
However, you do not need to reference the issue or PR numbers here | ||
as *towncrier* will automatically add a reference to all of the | ||
affected issues when rendering the news file. | ||
If you wish to sign your change, feel free to add | ||
``-- by :user:`github-username``` at the end (replace | ||
``github-username`` with your own!). | ||
|
||
Finally, name your file following the convention that Towncrier | ||
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 | |
changes accompanying the relevant code changes. | ||
|
||
Examples for adding changelog entries to your Pull Requests | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
----------------------------------------------------------- | ||
Dreamsorcerer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
File :file:`CHANGES/6045.doc.1.rst`: | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Dreamsorcerer this title was a mistake: