Skip to content

Commit

Permalink
Update issue/PR template + contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
angristan committed Jan 21, 2023
1 parent 48f8c16 commit 2d0eca1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
13 changes: 6 additions & 7 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -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 changes: 5 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 2d0eca1

Please sign in to comment.