octoleo/wireguard-install
1
1
Fork 0
mirror of https://github.com/angristan/wireguard-install.git synced 2024-11-21 12:25:08 +00:00
Code Issues Releases Activity

Add issue/PR templates, update README

Browse Source
This commit is contained in:
Stanislas Lange 2023-01-21 23:12:52 +01:00
parent 0fecf9d783
commit 591a3d2faa
No known key found for this signature in database
3 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.github/issue_template.md vendored Normal file
View File

@ -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.
--->

7
.github/pull_request_template.md vendored Normal file
View File

@ -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.
--->

20
README.md
View File

@ -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)