summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-09-23 09:38:50 +0200
committerMatthias Beyer <mail@beyermatthias.de>2021-09-23 09:38:50 +0200
commit56a22ff903df0d881bce88bf68cdb4de8bab06c1 (patch)
treec496544c68653a6ec83115475a12cfdea93462f7
parent67918eea3594a2c100465820e59d2341c18aa2f3 (diff)
parent43d5db8039f5955a628c08412fbd7da74cc12015 (diff)
Merge branch 'github-community'
-rw-r--r--.github/ISSUE_TEMPLATE.md29
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md30
-rw-r--r--CODE_OF_CONDUCT.md5
-rw-r--r--CONTRIBUTING.md32
4 files changed, 44 insertions, 52 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..2c4ca9c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,29 @@
+<!-- you found an issue? Awesome! Thanks for reporting! -->
+
+## What
+
+* [ ] Bug
+* [ ] Feature Request
+* [ ] Question
+* [ ] Other
+
+
+## Version
+
+**Butido Version:**
+**Rust Version:** <!-- feel free to remove if not relevant -->
+**Postgres Version:** <!-- feel free to remove if not relevant -->
+**Docker Version:** <!-- feel free to remove if not relevant -->
+**OS I'm running on:**
+
+
+For the lazy:
+
+```bash
+butido --version
+rustc --version
+docker --version
+uname -a
+cat /etc/os-release
+```
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9d7b8d3..f626031 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,27 +1,13 @@
-<!--
+<!-- short summary -->
-IMPORTANT NOTICE
+What I did:
-Github is only as mirror! Please send issues and pull requests via email to:
-* [matthias.beyer@atos.net](mailto:matthias.beyer@atos.net)
-* or publicly to [the butido mailinglist](mailto:~matthiasbeyer/butido@lists.sr.ht).
+## Checklist
+* [ ] all commits are `--signoff` ([Why?](/CONTRIBUTING.md))
+* [ ] No `!fixup` commits in the PR
+* [ ] I ran `cargo check --all --tests`
+* [ ] I ran `cargo test`
+* [ ] I ran `cargo clippy`
-To send patches (make sure to check the CONTRIBUTING.md file), for the lazy:
-
-```
-git format-patch --subject-prefix=butido \
- --to="~matthiasbeyer/butido@lists.sr.ht" \
- --to="matthias.beyer@atos.net" \
- --cover-letter \
- --numbered \
- --signoff \
- master..HEAD
-```
-
-
-We might miss your PR here on github. Either way, we will probably reach out to
-you via mail anyways.
-
--->
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..e8576d0
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,5 @@
+# Code of Conduct
+
+We adhere to the same
+[Code of Conduct as all Rust projects](https://www.rust-lang.org/policies/code-of-conduct).
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7d91a0b..109d6c0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,11 +5,8 @@ This file describes how you can contribute to butido.
## Reporting issues / Questions
-If you have a question regarding butido, feel free to send an email to
-one of the following addresses
-
-* "matthias.beyer@atos.net"
-* or publicly to [the mailinglist]("~matthiasbeyer/butido@lists.sr.ht")
+If you have a question regarding butido, feel free to open an issue or write an
+email to the authors.
## Submitting patches
@@ -57,28 +54,3 @@ By that you agree to the
> this project or the open source license(s) involved.
-You can submit patches using [git send-email](https://git-send-email.io/)
-and send email to the above email addresses.
-
-For the lazy:
-
-```
-git format-patch \
- --subject-prefix=butido \
- --to="~matthiasbeyer/butido@lists.sr.ht" \
- --cc="matthias.beyer@atos.net" \
- --cover-letter \
- --numbered \
- --signoff \
- master..HEAD
-
-# Edit the cover letter
-$EDITOR ./0000-cover-letter.patch
-
-# And send the patchset
-git send-email \
- --no-chain-reply-to \
- --to="~matthiasbeyer/butido@lists.sr.ht" \
- --cc="matthias.beyer@atos.net" \
- ./0*patch
-```