Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Ensure that all references to creating and reviewing PRs mention blurb and NEWS entries #358
Comments
|
A small but important point: in the past, i.e. before we had |
|
I agree that this should be clarified in the devguide. On my first PR, I was irritated (that word is maybe too strong) that the "bedevere/news" check fails. The devguide is not very clear on whether I should add the NEWS entry or the person accepting the PR should do it.
|
|
There are +s and -s with OP including a blurb. I plus is that the PR cannot be accidentally merged without some action. But on balance, I think it should be recommended whenever there is a bpo number. Before merging, I can edit or even delete, and editing online is easy. |
Other than for the most trivial sorts of changes (e.g. obvious spelling errors), nearly all changes to the cpython repo should include a NEWS entry; that's our primary mechanism to communicate changes with downstream users. We should be encouraging everyone, including non core-developers to submit PRs with NEWS entries. Among other benefits, having a NEWS entry makes reviews of the PR easier and helps to focus everyone include the submitter on what problem the PR is trying to address. And the tool we have to create NEWS entry is blurb; we want to encourage everyone creating or modifying a PR to use it. It's easier to delete the occasional unnecessary NEWS item than it is to create one when committing. To that end, suggest:
Create a section in the Git Bootcamp and Cheat Sheet
Accepting and Mergingsection to describe the details of using blurb with a fallback to how to manually create aMiscNEWS.dentry: basically, adapt and move the detailed info from the Accepting Pull Requests section. We want to be careful to encourageblurbusage and not encourage manually creation as the details could change in the future.This section should also include some guidelines on what a good NEWS entry looks like, or, if not here, one place in the devguide with references to it.
Review the whole document and add mentions of NEWS entries and the
blurbcommand everywhere creating or reviewing or committing a PR is discussed and include a link to the detailed section created above. In particular, the Lifecycle of a Pull Request section needs to be edited to include blurb.The text was updated successfully, but these errors were encountered: