Sfoglia il codice sorgente

Reword GitHub Issue & PR templates.

FelisCatus 7 anni fa
parent
commit
b28b87b63c
2 ha cambiato i file con 75 aggiunte e 32 eliminazioni
  1. 49 13
      .github/ISSUE_TEMPLATE.md
  2. 26 19
      .github/PULL_REQUEST_TEMPLATE.md

+ 49 - 13
.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 / 问题描述
+<!-- BEFORE YOU START / 请先读我
+
+SwitchyOmega is an open source project for proxy configuration. We cannot help
+you troubleshoot any proxy servers, proxy server software, or your network.
+We do not know how to make SwitchyOmega work with Software X or Company Y's Network.
+Please contact your network administrator or read the server manual.
+
+Please read the FAQ first: https://github.com/FelisCatus/SwitchyOmega/wiki/FAQ
+And then search the issue list: https://github.com/FelisCatus/SwitchyOmega/issues
+Then, feel free to delete this whole section and move on.
+
+----
+
+SwitchyOmega 是一个开源项目,用于代理设置。SwitchyOmega 不是翻墙软件。我们无法
+帮您分析代理服务器、代理软件、您所在地点的网络问题等。我们不知道怎样才能让
+SwitchyOmega 和某某软件(例如翻墙软件)一起工作,也不知道某公司、某地区的网络
+应该怎么设置代理。这些问题请联系您的网络管理员或者阅读代理服务器文档。
+
+(这里只进行 SwitchyOmega 项目开发、功能、故障有关的讨论,不是论坛或者问答社区。)
+
+请先阅读常见问题: https://github.com/FelisCatus/SwitchyOmega/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
+然后再搜索下现有的 Issue 列表: https://github.com/FelisCatus/SwitchyOmega/issues
+
+CLEAR ABOVE AFTER READ / 阅读后可删除以上内容 -->
+
+### 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 / 实际发生的情况(或建议修改后的行为)
+

+ 26 - 19
.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.
+### 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.