octoleo
/
openvpn-install
mirror of https://github.com/namibia/openvpn-install.git
1
1
Fork 0
Code Issues Releases Activity

Update issue/PR template + contributing guidelines

This commit is contained in:
Stanislas Lange 2023-01-21 23:06:44 +01:00
parent 48f8c16d3a
commit 2d0eca1a1d
No known key found for this signature in database
3 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.github/issue_template.md vendored
View File

@ -1,10 +1,9 @@
<!---
⚠️
If you need help with OpenVPN itself, please us the [community forums](https://forums.openvpn.net/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/openvpn)
Please prefer open a discussion thread of help: https://github.com/angristan/openvpn-install/discussions
It helps us to keep the issue tracker clean and focused on bugs and feature requests.
❗️ Please read ❗️
➡️ If you need help with OpenVPN itself, please use the community forums (https://forums.openvpn.net/) or Stack Overflow (https://stackoverflow.com/questions/tagged/openvpn)
➡️ For the script, prefer opening a discussion thread for help: https://github.com/angristan/openvpn-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, keep in mind that this script is meant to be simple and easy to use. If you want to add a lot of options, it's probably better to fork the project.
⚠️
🙏 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.
--->

11
.github/pull_request_template.md vendored
View File

@ -1,8 +1,7 @@
<!---
⚠️
Please make sure you've followed the guidelines: https://github.com/angristan/openvpn-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
⚠️
❗️ Please read ❗️
➡️ Please make sure you've followed the guidelines: https://github.com/angristan/openvpn-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.
--->

4
README.md
View File

@ -192,6 +192,10 @@ Solutions that provision a ready to use OpenVPN server based on this script in o
## 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/openvpn-install/blob/master/.github/workflows/push.yml).