From bde54094b832bd6d2f2b16d6290f375614c9ca97 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Fri, 17 Jul 2020 00:21:50 -0500 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/00-bug-report.md | 48 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/10-bug-report-zh.md | 48 ++++++++++++++++++++++ 2 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/00-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/10-bug-report-zh.md diff --git a/.github/ISSUE_TEMPLATE/00-bug-report.md b/.github/ISSUE_TEMPLATE/00-bug-report.md new file mode 100644 index 0000000..e1ea03d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug-report.md @@ -0,0 +1,48 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Checklist** + +- [ ] I read the [README](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README.md) +- [ ] I read the [Important notes](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README.md#important-notes) +- [ ] I followed instructions to [configure VPN clients](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README.md#next-steps) +- [ ] I checked [Troubleshooting](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients.md#troubleshooting) and [VPN status](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients.md#check-logs-and-vpn-status) +- [ ] I searched existing [Issues](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue) +- [ ] This bug is about the VPN setup scripts, and not IPsec VPN itself + + + +**Describe the issue** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. ... +2. ... + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +[Check logs and VPN status](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients.md#check-logs-and-vpn-status), and add error logs to help explain the problem, if applicable. + +**Server (please complete the following information)** +- OS: [e.g. Debian 10] +- Hosting provider (if applicable): [e.g. GCP, AWS] + +**Client (please complete the following information)** +- Device: [e.g. iPhone 8] +- OS: [e.g. iOS 13.6] +- VPN mode: [IPsec/L2TP, IPsec/XAuth ("Cisco IPsec") or IKEv2] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/10-bug-report-zh.md b/.github/ISSUE_TEMPLATE/10-bug-report-zh.md new file mode 100644 index 0000000..a68427c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-bug-report-zh.md @@ -0,0 +1,48 @@ +--- +name: 错误报告 +about: 请使用这个模板来提交 bug +title: '' +labels: '' +assignees: '' + +--- + +**任务列表** + +- [ ] 我已阅读 [自述文件](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md) +- [ ] 我已阅读 [重要提示](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md#重要提示) +- [ ] 我已按照说明 [配置 VPN 客户端](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/README-zh.md#下一步) +- [ ] 我检查了 [故障排除](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients-zh.md#故障排除) 以及 [VPN 状态](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients-zh.md#检查日志及-vpn-状态) +- [ ] 我搜索了已有的 [Issues](https://github.com/hwdsl2/setup-ipsec-vpn/issues?q=is%3Aissue) +- [ ] 这个 bug 是关于 VPN 安装脚本,而不是 IPsec VPN 本身 + + + +**问题描述** +使用清楚简明的语言描述这个 bug。 + +**重现步骤** +重现该 bug 的步骤: + +1. ... +2. ... + +**期待的正确结果** +简要地描述你期望的正确结果。 + +**日志** +[检查日志及 VPN 状态](https://github.com/hwdsl2/setup-ipsec-vpn/blob/master/docs/clients-zh.md#检查日志及-vpn-状态),并添加错误日志以帮助解释该问题(如果适用)。 + +**服务器信息(请填写以下信息)** +- 操作系统: [比如 Debian 10] +- 服务提供商(如果适用): [比如 GCP, AWS] + +**客户端信息(请填写以下信息)** +- 设备: [比如 iPhone 8] +- 操作系统: [比如 iOS 13.6] +- VPN 模式: [IPsec/L2TP, IPsec/XAuth ("Cisco IPsec") 或 IKEv2] + +**其它信息** +添加关于该 bug 的其它信息。