diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 2049011..452b671 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,13 +1,49 @@ -- SwitchyOmega is an open source project for proxy server switching and run with noneprofit / SwitchyOmega 是一个非营利、开源的代理服务器切换软件. (该项目与翻墙无关,请勿混淆) - -- Please read Wiki carefully, especially / 提问前请先阅读wiki https://github.com/FelisCatus/SwitchyOmega/wiki . -- Or search from Issue Board / 或在Issue Board中搜索 https://github.com/FelisCatus/SwitchyOmega/search?type=Issues -- Recommended to answer the following questions before submission. / 推荐按照以下格式描述你的问题 - -### SwitchyOmega version / SwitchyOmega版本 - - -### Environment(Web browser & OS) / 使用环境(浏览器及操作系统) - - -### Problem description / 问题描述 \ No newline at end of file + + +### SwitchyOmega version / SwitchyOmega 版本 + + +### Browser version & OS version / 浏览器名称、版本及操作系统版本 + + +### Problem description / 问题描述 + +(Please provide as much detail as possible. We recommend the following format.) +(请尽可能多提供一些细节。我们推荐使用下面的格式。) + +#### Steps to reproduce issue / 重现错误所需步骤 + +(What did you do? / 你做了什么?) + +1. +2. +3. + +#### Expected behavior / 期望发生的情况 + + +#### Actual (or suggested) behavior / 实际发生的情况(或建议修改后的行为) + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c55aa41..17b0ec6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,26 @@ -## Please follow the guide below - -- You will be asked some questions, please read them **carefully** and answer honestly -- Put an `x` into all the boxes [ ] relevant to your *pull request* (like that [x]) -- Use *Preview* tab to see how your *pull request* will actually look like - -- [ ] [Searched](https://github.com/FelisCatus/SwitchyOmega/search?q=is%3Apr&type=Issues) for similar pull requests -- [ ] Compiled the code with Node.js - -### What is the purpose of your *pull request*? -- [ ] Bug fix -- [ ] Improvement -- [ ] New feature - ---- - -### Description of your *pull request* and other information - -Explanation of your *pull request* in arbitrary form goes here. Please make sure the description explains the purpose and effect of your *pull request* and is worded well enough to be understood. Provide as much context and examples as possible. \ No newline at end of file +### What does this PR do? +- [ ] Bug fix +- [ ] Improvement +- [ ] New feature + +(Note: Translations and typo fixes should be done on https://hosted.weblate.org/projects/switchyomega/ instead of PR.) + +Please explain the changes in details here... + +#### Compatibility + +Is this PR compatible with old versions? Can users simply upgrade the extension? +Please describe any possible breaking changes (or surprising UX differences). + +#### Screenshots (if applicable) + +--- + +After creating the PR: + +- Please make sure the CircleCI test passes. Feel free to add more commits for +bug or style fixes. +- Any merge conflicts should be fixed on *your* side. Prefer rebasing to merging. +- Allow some time for project maintainers to review and merge the change. +- New features & behavior changes are subject to discussion. Please understand +that project maintainers may reject new features, or request changes.