]> git.madduck.net Git - etc/vim.git/blob - .github/PULL_REQUEST_TEMPLATE.md

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:

36f98c527f49203a7174816be8bc3ff06fc6e817
[etc/vim.git] / .github / PULL_REQUEST_TEMPLATE.md
1 <!-- Hello! Thanks for submitting a PR. To help make things go a bit more
2      smoothly we would appreciate that you go through this template. -->
3
4 ### Description
5
6 <!-- Good things to put here include: reasoning for the change (please link
7      any relevant issues!), any noteworthy (or hacky) choices to be aware of,
8      or what the problem resolved here looked like ... we won't mind a ranty
9      story :) -->
10
11 ### Checklist - did you ...
12
13 <!-- If any of the following items aren't relevant for your contribution
14      please still tick them so we know you've gone through the checklist.
15
16     All user-facing changes should get an entry. Otherwise, signal to us
17     this should get the magical label to silence the CHANGELOG entry check.
18     Tests are required for bugfixes and new features. Documentation changes
19     are necessary for formatting and most enhancement changes. -->
20
21 - [] Add a CHANGELOG entry if necessary?
22 - [] Add / update tests if necessary?
23 - [] Add new / update outdated documentation?
24
25 <!-- Just as a reminder, everyone in all psf/black spaces including PRs
26      must follow the PSF Code of Conduct (link below).
27
28      Finally, once again thanks for your time and effort. If you have any
29      feedback in regards to your experience contributing here, please
30      let us know!
31
32      Helpful links:
33
34       PSF COC: https://www.python.org/psf/conduct/
35       Contributing docs: https://black.readthedocs.io/en/latest/contributing/index.html
36       Chat on Python Discord: https://discord.gg/RtVdv86PrH -->