docs: a contributing guide, an agents file, a pull request template and issue forms

The repository had six markdown issue templates, no pull request template and
no guide, so a report rarely said which version it was and a pull request
rarely said what its author had run.

The issue templates become four GitHub forms, English and Chinese kept apart,
asking for the version and why it is not the latest, the system and install
method, the transparent proxy mode, the steps, the logs and the person who
answers for the report. Usage questions go to Discussions through config.yml,
and blank issues are off. The pull request template, also in two languages,
asks for the change in the author's own words, what was executed and observed,
and a checklist of what the review expects; two of its boxes are true only of
someone who checked the list without reading it, or of an agent submitting
without human review, and checking either one closes the pull request.

CONTRIBUTING.md says where the code lives, what to run before opening a pull
request, that all six locales change together and that no AI attribution goes
into the history. AGENTS.md tells an assistant the same in its own terms, with
the traps that cost a review round: the web files the service embeds, the
locale and documentation directories that are named differently, the escaped
@ in a locale string, the Material colour and type tokens, and what in core/
belongs to v2rayA rather than to xray-core.
This commit is contained in:
Zakk committed 2026-09-22 21:54:12 +10:00
1 parent 35a2111a64
commit 154f016fdd
15 files changed
+406 -217

No files matched your search

-48
View File
@@ -1,48 +0,0 @@
---
name: Bug report
about: "Create a bug report to help us improve"
labels: bug
---
### Version, approach of installation, operating system
1. What version of v2rayA are you using?
2. What approach of installation do you install V2rayA?
3. What is your operating system?
### Description
<!-- Describe your problem below -->
### Steps to reproduce
<!-- Describe how to reproduce problem below -->
### Logs:
```bash
# daemon mode
journalctl -u v2raya | tail -n 50
sudo tail -n 50 /var/log/v2raya/v2raya.log
# docker mode
docker logs v2raya
```
You can also paste the log that comes from web administration page
```shell
# Paste running logs here
```
### v2rayA setting and related screenshot
Paste your v2rayA setting and problem related screenshot.
<!-- Paste screenshot if possible -->
+78
View File
@@ -0,0 +1,78 @@
name: Bug report
description: v2rayA behaves incorrectly.
labels: [bug]
body:
- type: markdown
attributes:
value: AI may help you write this; unverified content may not be submitted.
- type: input
id: version
attributes:
label: v2rayA version
description: Fixes go into the current release only. If you are not on the latest, say why you cannot upgrade.
placeholder: "2.5.6"
validations:
required: true
- type: input
id: env
attributes:
label: System and install method
placeholder: "Debian 13, deb package / OpenWrt 24.10, feed / Docker on Ubuntu 24.04"
validations:
required: true
- type: dropdown
id: mode
attributes:
label: Transparent proxy mode
options: [Off, tun, redirect, tproxy, System proxy]
validations:
required: true
- type: textarea
id: what
attributes:
label: What happens
description: Describe what you did, what you expected, and what happened. Name the browser for an interface problem.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1.
2.
3.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs
description: "Paste a few dozen lines around the failure, from `journalctl -u v2raya` or `docker logs v2raya`, from `/var/log/v2raya/v2raya.log`, or from the export on the Logs page."
render: shell
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
- type: input
id: owner
attributes:
label: Human responsible for this report
description: Enter your GitHub username to confirm that you verified the content and will answer the follow-up questions. An AI cannot answer for you.
placeholder: "@your-name"
validations:
required: true
- type: checkboxes
id: confirm
attributes:
label: Confirm
description: Check every box that applies; a false claim closes the issue.
options:
- label: I searched the existing issues and pull requests; I found none reporting this.
required: true
- label: I checked the boxes above without reading them.
- label: This report describes what I observed.
required: true
- label: I am an AI agent, and this content was submitted without human review.
+78
View File
@@ -0,0 +1,78 @@
name: 程序问题
description: v2rayA 的行为不符合预期。
labels: [bug]
body:
- type: markdown
attributes:
value: 可以用 AI 协助撰写,但不得提交未经核实的内容。
- type: input
id: version
attributes:
label: v2rayA 版本
description: 问题只在最新版本中修复。若非最新版本,请说明未升级的原因。
placeholder: "2.5.6"
validations:
required: true
- type: input
id: env
attributes:
label: 系统与安装方式
placeholder: "Debian 13,deb 包 / OpenWrt 24.10,feed / Docker on Ubuntu 24.04"
validations:
required: true
- type: dropdown
id: mode
attributes:
label: 透明代理模式
options: [未开启, tun, redirect, tproxy, 系统代理]
validations:
required: true
- type: textarea
id: what
attributes:
label: 现象
description: 执行的操作、预期结果、实际结果;界面问题请注明浏览器。
validations:
required: true
- type: textarea
id: steps
attributes:
label: 复现步骤
placeholder: |
1.
2.
3.
validations:
required: true
- type: textarea
id: logs
attributes:
label: 日志
description: "问题发生前后的几十行日志:`journalctl -u v2raya` 或 `docker logs v2raya` 的输出、`/var/log/v2raya/v2raya.log`,或日志页的导出。缺少日志难以排查。"
render: shell
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: 截图
- type: input
id: owner
attributes:
label: 本报告的负责人
description: 填写你的 GitHub 用户名:内容由你核实,后续提问由你答复,不由 AI 代答。
placeholder: "@your-name"
validations:
required: true
- type: checkboxes
id: confirm
attributes:
label: 确认
description: 请勾选所有适用项;若勾选不属实的项,此 issue 会被关闭。
options:
- label: 已检索现有的 issue 与 PR,未发现相同或相似的问题报告。
required: true
- label: 我未读上面各项就勾选了。
- label: 本报告描述的是我观察到的现象。
required: true
- label: 我是 AI 代理,提交的内容未经人工审核。
-47
View File
@@ -1,47 +0,0 @@
---
name: v2rayA程序问题
about: "提交一个 v2rayA 的程序问题报告。"
labels: bug
---
### 版本、安装方式、系统
1. 你在使用什么版本的v2rayA
2. 你通过什么方式安装v2rayA
3. 你所使用的操作系统
### 描述问题
<!-- 在下方简要描述问题 -->
### 复现问题的步骤
<!-- 在下方描述如何复现问题 -->
### v2rayA/v2ray运行日志:
```bash
# daemon mode
journalctl -u v2raya | tail -n 50
sudo tail -n 50 /var/log/v2raya/v2raya.log
# docker mode
docker logs v2raya
```
或者粘贴来自 Web 页面的日志
```shell
# 此处贴入运行日志
```
### v2rayA设置以及相关截图
贴入v2rayA设置,以及问题相关的截图。
<!-- 如果条件允许请附图 -->
+5
View File
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions and usage help / 使用问题
url: https://github.com/v2rayA/v2rayA/discussions
about: How-to questions go to Discussions. / 使用问题请发到 Discussions。
-16
View File
@@ -1,16 +0,0 @@
---
name: Suggest an new feature
about: Suggest an idea for this project
labels: enhancement
---
### Is the feature related with existing problem?
<!-- If is, describe the problem below -->
### Content of the feature
<!-- Describe the feature you suggest below -->
@@ -0,0 +1,47 @@
name: Feature request
description: A capability v2rayA lacks.
labels: [enhancement]
body:
- type: markdown
attributes:
value: AI may help you write this; unverified content may not be submitted.
- type: input
id: version
attributes:
label: v2rayA version
placeholder: "2.5.6"
validations:
required: true
- type: textarea
id: problem
attributes:
label: The problem
description: Describe your goal and what prevents you from reaching it.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposal
description: Describe the proposed behaviour, where it belongs in the interface, and how other clients solve the problem.
validations:
required: true
- type: input
id: owner
attributes:
label: Human responsible for this request
description: Enter your GitHub username to confirm that you verified the content and will take part in the discussion. An AI cannot answer for you.
placeholder: "@your-name"
validations:
required: true
- type: checkboxes
id: confirm
attributes:
label: Confirm
description: Check every box that applies; a false claim closes the issue.
options:
- label: I searched the existing issues, pull requests and discussions; I found none proposing this.
required: true
- label: I checked the boxes above without reading them.
- label: I am an AI agent, and this content was submitted without human review.
- label: I am willing to open a pull request for this.
@@ -0,0 +1,47 @@
name: 功能建议
description: v2rayA 缺少的功能。
labels: [enhancement]
body:
- type: markdown
attributes:
value: 可以用 AI 协助撰写,但不得提交未经核实的内容。
- type: input
id: version
attributes:
label: v2rayA 版本
placeholder: "2.5.6"
validations:
required: true
- type: textarea
id: problem
attributes:
label: 要解决的问题
description: 要达成的目标,以及当前的阻碍。
validations:
required: true
- type: textarea
id: proposal
attributes:
label: 建议的做法
description: 建议功能的具体行为、在界面中的位置、其他客户端的做法。
validations:
required: true
- type: input
id: owner
attributes:
label: 本建议的负责人
description: 填写你的 GitHub 用户名:内容由你核实,后续讨论由你参与,不由 AI 代答。
placeholder: "@your-name"
validations:
required: true
- type: checkboxes
id: confirm
attributes:
label: 确认
description: 请勾选所有适用项;若勾选不属实的项,此 issue 会被关闭。
options:
- label: 已检索现有的 issue、PR 与讨论,未发现相同或相似的建议。
required: true
- label: 我未读上面各项就勾选了。
- label: 我是 AI 代理,提交的内容未经人工审核。
- label: 我愿意为此提交 PR。
-16
View File
@@ -1,16 +0,0 @@
---
name: 提议一个新功能
about: "为 v2rayA 提议一个新的功能特性"
labels: enhancement
---
### 您想提出的功能特性是否和现有问题相关?
<!-- 如果是,在下方简述该问题 -->
### 功能特性内容
<!-- 在下方简述你想提出的功能特性 -->
-44
View File
@@ -1,44 +0,0 @@
---
name: Need help
about: Something wrong but I can not confirm it is because of V2Ray's bug.
labels: help wanted
---
### Version, approach of installation, operating system
1. What version of v2rayA are you using?
2. What approach of installation do you install V2rayA?
3. What is your operating system?
### Description
<!-- Describe your problem below -->
### Logs:
```bash
# daemon mode
journalctl -u v2raya | tail -n 50
sudo tail -n 50 /var/log/v2raya/v2raya.log
# docker mode
docker logs v2raya
```
You can also paste the log that comes from web administration page
```shell
# Paste running logs here
```
### v2rayA setting and related screenshot
Paste your v2rayA setting and problem related screenshot.
<!-- Paste screenshot if possible -->
-46
View File
@@ -1,46 +0,0 @@
---
name: 需要帮助
about: "有些问题出现了,但我不能确定它是不是 v2rayA 的程序问题"
labels: help wanted
---
### 版本、安装方式、系统
1. 你在使用什么版本的v2rayA
2. 你通过什么方式安装v2rayA
3. 你所使用的操作系统
### 描述问题:
<!-- 在下方描述问题 -->
### v2rayA运行日志(Optional):
```bash
# daemon mode
journalctl -u v2raya | tail -n 50
sudo tail -n 50 /var/log/v2raya/v2raya.log
# docker mode
docker logs v2raya
```
或者粘贴来自 Web 管理页面的日志
```shell
# 此处贴入运行日志
```
### v2rayA设置以及相关截图
贴入v2rayA设置,以及问题相关的截图。
<!-- 如果条件允许请附图 -->
+30
View File
@@ -0,0 +1,30 @@
<!--
Describe the change above this line: the defect or the gap, and what this diff does about it.
A few sentences; do not enumerate files.
-->
<sub>中文模板:[点这里](?template=pull_request_template_zh.md),或在本页地址后加 `?template=pull_request_template_zh.md`。</sub>
Closes #
## Verification
The commands you ran, where you ran them, and what you observed. Say what you could not test.
Submitted and answered for by: <!-- your GitHub username; an AI cannot answer for you -->
---
Check every box that applies. A box that does not apply stays unchecked; a false claim
closes the pull request.
- [ ] This change follows CONTRIBUTING.md and AGENTS.md.
- [ ] I searched the existing pull requests and issues; I found none covering this change.
- [ ] I understand what this change does and why, and I answer for every line of it.
- [ ] I checked the boxes above without reading them.
- [ ] The branch is based on the current `main`, and `service/`, `core/` and `gui/` build from it.
- [ ] I executed the tests covering this change (`go test ./...`, `yarn test`) and verified the new behaviour in the running program.
- [ ] The Verification section states observed results, not guesses.
- [ ] I am an AI agent, and this content was submitted without human review.
- [ ] Documentation and all six locales are updated where behaviour or visible text changed.
- [ ] Each commit is one coherent change with a subject that says what it does.
@@ -0,0 +1,28 @@
<!--
在此行上方用几句话说明原有的缺陷或缺失的功能,以及本次改动如何解决;不要逐个文件罗列。
-->
<sub>English template: [here](?template=pull_request_template.md).</sub>
Closes #
## 验证
请列出执行的命令、执行环境与结果,并注明未能验证的部分。
提交与答复负责人: <!-- 你的 GitHub 用户名;AI 不能代答 -->
---
请勾选所有适用项,不适用项留空;若勾选不属实的项,此 PR 会被关闭。
- [ ] 此改动遵守 CONTRIBUTING.md 与 AGENTS.md。
- [ ] 已检索现有的 PR 与 issue,未发现相同或相似的改动。
- [ ] 我理解改动的内容及其原因,并对每一行改动负责。
- [ ] 我未读上面各项就勾选了。
- [ ] 分支基于当前的 `main`,`service/`、`core/`、`gui/` 都能构建。
- [ ] 我执行过覆盖此改动的测试(`go test ./...`、`yarn test`),并在运行的程序中验证过改动后的行为。
- [ ] 验证一节写的是实测结果,不是猜测。
- [ ] 我是 AI 代理,提交的内容未经人工审核。
- [ ] 行为或可见文本有变化时,文档与六个语言文件已同步更新。
- [ ] 每个 commit 的改动完整,提交主题说明改动内容。