]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Push contributors to use Next PR Number (#2080)
authorRichard Si <63936253+ichard26@users.noreply.github.com>
Thu, 1 Apr 2021 21:24:18 +0000 (17:24 -0400)
committerGitHub <noreply@github.com>
Thu, 1 Apr 2021 21:24:18 +0000 (14:24 -0700)
This is a tool of my own making. Right now our requirement to have the
PR number in the changelog entry is pretty painful / annoying since
the contributor either has to guess or add the # retroactively after
the PR creation. This tool should make it way less painful by making
it simple to get your PR number beforehand.

CONTRIBUTING.md
docs/contributing_to_black.md

index 8a3d8bf2830e45ac2fe6304330bf80a6207e008f..bd6ebfca1140c091fa8624c37c8b14894ee14d85 100644 (file)
@@ -69,11 +69,10 @@ have a line in the following format:
 - `Black` is now more awesome (#X)
 ```
 
 - `Black` is now more awesome (#X)
 ```
 
-To workout X, checkout the latest issue and PR number and add 1. This is not perfect but
-saves a lot of release overhead as now the releaser does not need to go back and workout
-what to add to the `CHANGES.md` for each release.
-
-_Suggestions welcome on how this could be a better less invasive flow._
+To workout X, please use
+[Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
+is not perfect but saves a lot of release overhead as now the releaser does not need to
+go back and workout what to add to the `CHANGES.md` for each release.
 
 ### Docs Testing
 
 
 ### Docs Testing
 
index 562b43a76ac9b85a8cb6b9f5178f8b543c69c28e..b911b465afd352aae1942e849a127911a6401b8d 100644 (file)
@@ -60,6 +60,22 @@ $ tox -e fuzz
 $ black-primer [-k -w /tmp/black_test_repos]
 ```
 
 $ black-primer [-k -w /tmp/black_test_repos]
 ```
 
+### News / Changelog Requirement
+
+`Black` has CI that will check for an entry corresponding to your PR in `CHANGES.md`. If
+you feel this PR not require a changelog entry please state that in a comment and a
+maintainer can add a `skip news` label to make the CI pass. Otherwise, please ensure you
+have a line in the following format:
+
+```md
+- `Black` is now more awesome (#X)
+```
+
+To workout X, please use
+[Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
+is not perfect but saves a lot of release overhead as now the releaser does not need to
+go back and workout what to add to the `CHANGES.md` for each release.
+
 ### Docs Testing
 
 If you make changes to docs, you can test they still build locally too.
 ### Docs Testing
 
 If you make changes to docs, you can test they still build locally too.