diff options
author | Phil Pennock <pdp@exim.org> | 2018-02-25 02:51:22 -0500 |
---|---|---|
committer | Phil Pennock <pdp@exim.org> | 2018-02-25 02:51:22 -0500 |
commit | b988b06146c5d16e0ca0ea86ffcf2d83938088ed (patch) | |
tree | 09e057c4eaca3ab3c1741a1c7475af5b1bbc7484 /.github/PULL_REQUEST_TEMPLATE.md | |
parent | e6532c4a78619d4ea45b6e95b738189eebf8859a (diff) |
meta: git controls for text changelogs; github controls
For the ChangeLog and files like it, use `merge=union` to bring in
content from both sides instead of having conflicts block merges because
someone else added a feature.
For GitHub, provide some "templates" which really just point people in
the right direction, but if the repointing fails, at least reduces the
pain a little.
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8fa5a40df --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,41 @@ +# The Exim Project does not use GitHub Issues + +Hey, we want your input, but we want to make sure that we actually see it and +that your help is not wasted, so please read this. + +The GitHub repo exists for convenience for some folks, and to host our Wiki. +The Git repo is an automated clone of our real repo over at +<https://git.exim.org/exim.git>. + +Sometimes a maintainer will take a look at GitHub pull requests, just because +we care about the software and want to know about issues, but expect long +delays. It's not a really supported workflow. + +Our bug-tracker takes code-patches and is the place to go: +<https://bugs.exim.org/> + +If you've found a security bug, then please email <security@exim.org>. +All Exim Maintainers can and do use PGP. +Keyring: <https://ftp.exim.org/pub/exim/Exim-Maintainers-Keyring.asc> +We don't have a re-encrypting mailer, just encrypt to all of them please. + +## If this is too much hassle ... + +We do periodically get around to checking GitHub Pull Requests. +It just won't be fast. + +Patches should update the documentation, `doc/doc-docbook/spec.xfpt`; if you +like, just provide the plaintext which should go in there and we can mark it +up. + +If it's a whole new feature, then please guard it with a build +option `EXPERIMENTAL_FOO`; docs are in plaintext in +`doc/doc-txt/experimental-spec.txt`. + +If you're feeling particularly thorough, these files get updated too: +* `doc/doc-txt/ChangeLog` : all changes; workflow pre-dates Git +* `doc/doc-txt/NewStuff` : if it's a change in intended behavior which postmasters should read +* `doc/doc-txt/OptionLists.txt` : (we usually defer this until cutting a release) +* `src/README.UPDATING` : if you're breaking backwards compatibility + +Thanks! |