From 64d2a95bf42380c93b6cbfa7f57e9462b42eda50 Mon Sep 17 00:00:00 2001 From: V2Ray Date: Sun, 13 Sep 2015 12:57:21 +0200 Subject: [PATCH] Issue guide --- README.md | 5 +++++ spec/issue.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 spec/issue.md diff --git a/README.md b/README.md index 2c498c629..befd9944e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,11 @@ V2Ray 是一个翻墙工具包,用于简化和复用其它翻墙工具,加 ## 概要设计 [链接](https://github.com/V2Ray/v2ray-core/blob/master/spec/design.md) +## 联系方式 +公开的建议或意见请发 [Issue](https://github.com/v2ray/v2ray-core/issues),发 Issue 之前请先阅读 [Issue 指引](https://github.com/V2Ray/v2ray-core/blob/master/spec/design.md)。 + +私下联系:admin@v2ray.com + ## 合作机会 所有被标记为“[Help Wanted](https://github.com/v2ray/v2ray-core/labels/help%20wanted)”的 Issue 都接受 Pull Request,如果你对本项目感兴趣并想做点贡献,请挑选其中之一完善之,不甚感激。 diff --git a/spec/issue.md b/spec/issue.md new file mode 100644 index 000000000..9a2af11a9 --- /dev/null +++ b/spec/issue.md @@ -0,0 +1,37 @@ +# Issue 指引 + +在新建 Issue 之前请先阅读下面的内容,以提高 Issue 的质量和效率。 + +## 开放分类 +在创建 Issue 的时候可标记为以下分类: + +### Bug +代码的质量问题,可以是功能性(Functionality),稳定性(Reliability)或者性能(Performance)。在 Bug 的内容中请注明下列内容以方便重现: + +* 操作系统:如 Windows 10,Ubuntu 14.04 等,64 位 / 32 位 +* V2Ray 版本:版本号或源码同步日期 +* Golang 版本:如果有的话 +* 问题描述:任何的错误信息,不正常的行为等 +* 日志文件:如果有的话 + +如对软件使用有作何问题也请发到这个类别 + +### Chat +聊天或其它相关性不强的内容。标记为 Chat 的 Issue 将在最后回复 7 天后关闭。 + +### Enhancemet +有关新特性的建议,如果是针对现有代码的修改,请详细描述您的建议。 + +## 以下分类仅供管理员使用 +### Help Wanted +标记为 Help Wanted 的 Issue 接受 Pull Request,一般为新特性的实现,如果您对其中某一个感兴趣,欢迎供献代码。 + +### Duplicate +此 Issue 与之前的某一个 Issue 重复。 + +### Invalid +无法重现的 Bug 或没有意义的 Issue。 + +### Won't fix +此 Issue 是一个合理的问题,但不影响软件的正常使用,故不修复。 +