mirror of
https://github.com/hansjone/netx.git
synced 2026-10-08 22:20:58 +08:00
docs: add CONTRIBUTING and GitHub issue templates
Document fork/PR workflow; add bug and feature issue templates. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
parent
b997c3ee49
commit
0e0d6141e0
5 changed files with 66 additions and 0 deletions
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
name: 缺陷报告
|
||||
about: 报告可复现的问题
|
||||
title: "[bug] "
|
||||
labels: ["bug"]
|
||||
---
|
||||
|
||||
## 环境
|
||||
|
||||
- OS:
|
||||
- Python / Node(如相关):
|
||||
- 分支 / 提交(可选):
|
||||
|
||||
## 现象
|
||||
|
||||
## 预期
|
||||
|
||||
## 复现步骤
|
||||
|
||||
1.
|
||||
2.
|
||||
|
||||
## 补充
|
||||
|
||||
- API 路径或前端页面:
|
||||
- 请勿粘贴密钥或 `.env` 内容。
|
||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
blank_issues_enabled: true
|
||||
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
name: 功能建议
|
||||
about: 提议新能力或改进
|
||||
title: "[feat] "
|
||||
labels: ["enhancement"]
|
||||
---
|
||||
|
||||
## 背景 / 动机
|
||||
|
||||
## 建议方案
|
||||
|
||||
## 其它
|
||||
|
||||
- 是否愿意自行提交 PR:(是 / 否 / 未确定)
|
||||
21
CONTRIBUTING.md
Normal file
21
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# 参与贡献
|
||||
|
||||
外部协作默认通过 **Fork → 分支 → Pull Request**;仓库所有者审阅合并后,你在本机 `git pull` 即可同步。
|
||||
|
||||
## 流程摘要
|
||||
|
||||
1. Fork 本仓库,克隆你的 Fork。
|
||||
2. 基于当前默认分支(一般为 `main`)创建主题分支,例如 `fix/...` 或 `feat/...`。
|
||||
3. 提交并推送到你的 Fork,在 GitHub 上向本仓库发起 PR,说明变更内容与测试方式。
|
||||
|
||||
## 合并前注意
|
||||
|
||||
- 不要提交 `.env`、数据库口令、生产 URL 等敏感信息;以 `.env.example` / 文档中的占位符为准。
|
||||
- Python 使用仓库约定的虚拟环境(见 `README.md`「Environment setup」)。
|
||||
- 若改动 API、数据库或前端类型,请同步更新对应层(后端 schema / 前端 `types`)并尽量本地验证。
|
||||
|
||||
## 问题反馈
|
||||
|
||||
请使用 GitHub Issues(仓库内提供模板),写清复现步骤与环境。
|
||||
|
||||
若仓库暂不接收外部 PR,可在 README 中说明;本文档仍可供团队内部参考。
|
||||
|
|
@ -145,3 +145,7 @@ Optional: configure oclaw health check endpoint (defaults shown in `.env.example
|
|||
Phase 1 parser is tuned for:
|
||||
|
||||
`D:/project/chatgpt/fm-active-Alarm Monitor-CHEN-20260423100105/fm-active-Alarm Monitor-CHEN-20260423100105.xlsx`
|
||||
|
||||
## Contributing
|
||||
|
||||
Fork / PR 流程与注意事项见仓库根目录 `CONTRIBUTING.md`。
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue