From 591a3d2faa16e1a37bace6580b4c9f2e946fde72 Mon Sep 17 00:00:00 2001
From: Stanislas Lange <git@slange.me>
Date: Sat, 21 Jan 2023 23:12:52 +0100
Subject: [PATCH] Add issue/PR templates, update README

---
 .github/issue_template.md        |  9 +++++++++
 .github/pull_request_template.md |  7 +++++++
 README.md                        | 20 +++++++++++++++++++-
 3 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 .github/issue_template.md
 create mode 100644 .github/pull_request_template.md

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.
+--->
diff --git a/README.md b/README.md
index 15f5068..77b65c0 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ The server will apply NAT to the client's traffic so it will appear as if the cl
 
 The script supports both IPv4 and IPv6. Please check the [issues](https://github.com/angristan/wireguard-install/issues) for ongoing development, bugs and planned features!
 
-WireGuard does not fit your environment? Check out [openvpn-install](https://github.com/angristan/openvpn-install).
+WireGuard does not fit your environment? Check out [openvpn-install](https://github.com/angristan/wireguard-install).
 
 ## Requirements
 
@@ -47,3 +47,21 @@ I recommend these cheap cloud providers for your VPN server:
 - [Hetzner](https://hetzner.cloud/?ref=ywtlvZsjgeDq): Germany, Finland and United States, IPv6, 20 TB of traffic, starting at €3/month
 - [Digital Ocean](https://goo.gl/qXrNLK): Worldwide locations, IPv6 support, starting at \$4/month
 - [PulseHeberg](https://goo.gl/76yqW5): France, unlimited bandwidth, starting at €3/month
+
+## Contributing
+
+## Discuss changes
+
+Please open an issue before submitting a PR if you want to discuss a change, especially if it's a big one.
+
+### Code formatting
+
+We use [shellcheck](https://github.com/koalaman/shellcheck) and [shfmt](https://github.com/mvdan/sh) to enforce bash styling guidelines and good practices. They are executed for each commit / PR with GitHub Actions, so you can check the configuration [here](https://github.com/angristan/wireguard-install/blob/master/.github/workflows/lint.yml).
+
+## Say thanks
+
+You can [say thanks](https://saythanks.io/to/angristan) if you want!
+
+## Credits & Licence
+
+This project is under the [MIT Licence](https://raw.githubusercontent.com/angristan/wireguard-install/master/LICENSE)