aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorStanislas Lange <git@slange.me>2023-01-21 23:12:52 +0100
committerStanislas Lange <git@slange.me>2023-01-21 23:12:58 +0100
commit591a3d2faa16e1a37bace6580b4c9f2e946fde72 (patch)
treecaa74878bbc7de07ef5bdeab5d973e971cbd5054 /.github
parent0fecf9d783ccb53c6c583e024669e3efe4151227 (diff)
Add issue/PR templates, update README
Diffstat (limited to '.github')
-rw-r--r--.github/issue_template.md9
-rw-r--r--.github/pull_request_template.md7
2 files changed, 16 insertions, 0 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 0000000..0f6429b
--- /dev/null
+++ b/.github/issue_template.md
@@ -0,0 +1,9 @@
+<!---
+❗️ Please read ❗️
+➡️ If you need help with OpenVPN itself, please use the community forums (https://www.reddit.com/r/WireGuard/) or Stack Overflow (https://stackoverflow.com/questions/tagged/wireguard)
+➡️ For the script, prefer opening a discussion thread for help: https://github.com/angristan/wireguard-install/discussions
+💡 It helps keep the issue tracker clean and focused on bugs and feature requests.
+
+🙏 Please include as much information as possible, and make sure you're running the latest version of the script.
+✋ For feature requests, remember that this script is meant to be simple and easy to use. If you want to add a lot of options, it's better to fork the project.
+--->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..2940147
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,7 @@
+<!---
+❗️ Please read ❗️
+➡️ Please make sure you've followed the guidelines: https://github.com/angristan/wireguard-install#contributing
+✅ Please make sure your changes are tested and working
+🗣️ Please avoid large PRs, and discuss changes in a GitHub issue first
+✋ If the changes are too big and not in line with the project, they will probably be rejected. Remember that this script is meant to be simple and easy to use.
+--->