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:

MNT: add pull request template (#2443)
authorRichard Si <63936253+ichard26@users.noreply.github.com>
Thu, 26 Aug 2021 01:25:44 +0000 (21:25 -0400)
committerGitHub <noreply@github.com>
Thu, 26 Aug 2021 01:25:44 +0000 (21:25 -0400)
So we don't have to request changes on these basic requirements as
often - hopefully :)

.github/PULL_REQUEST_TEMPLATE.md [new file with mode: 0644]

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..36f98c5
--- /dev/null
@@ -0,0 +1,36 @@
+<!-- Hello! Thanks for submitting a PR. To help make things go a bit more
+     smoothly we would appreciate that you go through this template. -->
+
+### Description
+
+<!-- Good things to put here include: reasoning for the change (please link
+     any relevant issues!), any noteworthy (or hacky) choices to be aware of,
+     or what the problem resolved here looked like ... we won't mind a ranty
+     story :) -->
+
+### Checklist - did you ...
+
+<!-- If any of the following items aren't relevant for your contribution
+     please still tick them so we know you've gone through the checklist.
+
+    All user-facing changes should get an entry. Otherwise, signal to us
+    this should get the magical label to silence the CHANGELOG entry check.
+    Tests are required for bugfixes and new features. Documentation changes
+    are necessary for formatting and most enhancement changes. -->
+
+- [] Add a CHANGELOG entry if necessary?
+- [] Add / update tests if necessary?
+- [] Add new / update outdated documentation?
+
+<!-- Just as a reminder, everyone in all psf/black spaces including PRs
+     must follow the PSF Code of Conduct (link below).
+
+     Finally, once again thanks for your time and effort. If you have any
+     feedback in regards to your experience contributing here, please
+     let us know!
+
+     Helpful links:
+
+      PSF COC: https://www.python.org/psf/conduct/
+      Contributing docs: https://black.readthedocs.io/en/latest/contributing/index.html
+      Chat on Python Discord: https://discord.gg/RtVdv86PrH -->