Skip to content

Commit 1ed3940

Browse files
committed
chore: 企业级标准化 — 补全社区文档和CI安全配置
1 parent bd0c3ec commit 1ed3940

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 贡献指南
2+
3+
感谢您对本项目的关注!我们欢迎所有形式的贡献。
4+
5+
## 📜 行为准则
6+
7+
参与本项目即表示您同意遵守我们的 [行为准则](CODE_OF_CONDUCT.md)
8+
9+
## 💡 如何贡献
10+
11+
### 报告 Bug
12+
13+
1. 搜索现有 Issues,确保该问题尚未被报告
14+
2. 使用 Bug 报告模板创建 Issue
15+
3. 提供详细的复现步骤和环境信息
16+
17+
### 提出功能需求
18+
19+
1. 搜索现有 Issues/Discussions
20+
2. 使用功能需求模板创建 Issue
21+
3. 详细描述使用场景和预期的解决方案
22+
23+
### 提交代码
24+
25+
1. Fork 仓库
26+
2. 基于 `main` 分支创建功能分支
27+
3. 遵循现有代码风格
28+
4. 提交 Pull Request
29+
30+
## 🔧 开发流程
31+
32+
### 环境搭建
33+
34+
```bash
35+
git clone https://github.com/xiejianjun000/{REPO}.git
36+
cd {REPO}
37+
npm install
38+
```
39+
40+
### 分支策略
41+
42+
| 分支 | 说明 |
43+
|------|------|
44+
| `main` | 主分支,稳定可发布 |
45+
| `feature/*` | 功能开发分支 |
46+
| `bugfix/*` | Bug 修复分支 |
47+
48+
### 提交规范
49+
50+
使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范:
51+
52+
```
53+
<type>(<scope>): <subject>
54+
```
55+
56+
- `feat` - 新功能
57+
- `fix` - Bug 修复
58+
- `docs` - 文档更新
59+
- `chore` - 构建/工具变动
60+
- `refactor` - 重构
61+
- `test` - 测试
62+
63+
## 🧪 测试
64+
65+
```bash
66+
npm test
67+
```
68+
69+
## 🔍 代码审查
70+
71+
所有 PR 需要至少一位维护者审查通过后方可合并。

0 commit comments

Comments
 (0)