docs(contributing): 添加贡献指南和行为准则文档

2025-11-26 15:38:26 +08:00
parent 61fd492604
commit b628c8c5a4
2 changed files with 88 additions and 0 deletions
@@ -0,0 +1,41 @@
+# 行为准则
+
+## 承诺
+
+为了营造一个开放和受欢迎的环境，我们作为贡献者和维护者承诺使参与我们的项目和社区成为每个人的无骚扰体验，无论年龄、体型、残疾、种族、性别认同和表达、经验水平、教育程度、社会经济地位、国籍、个人外表、种族、宗教或性认同和取向。
+
+## 标准
+
+有助于创造积极环境的行为包括：
+
+* 使用欢迎和包容的语言
+* 尊重不同的观点和经历
+* 优雅地接受建设性批评
+* 关注对社区最有利的事情
+* 对其他社区成员表示同情
+
+参与者不可接受的行为包括：
+
+* 使用与性有关的言语或图像以及不受欢迎的性关注或挑逗
+* 捣乱/煽动性评论，人身攻击，政治攻击
+* 公开或私下骚扰
+* 未经明确许可发布他人私人信息，如物理或电子地址
+* 其他可能在专业环境中被合理认为不适当的行为
+
+## 责任
+
+项目维护人员负责澄清可接受行为的标准，并应对任何不可接受行为采取适当和公正的纠正措施。
+
+项目维护人员有权并有责任删除、编辑或拒绝与本行为准则不符的评论、提交、代码、维基编辑、问题和其他贡献，或暂时或永久禁止任何贡献者，以他们认为适当的方式。
+
+## 范围
+
+本行为准则适用于项目空间和公共场所，当个人代表项目或其社区时。代表项目或社区的例子包括使用官方项目电子邮件地址、通过官方社交媒体账户发帖或在线或线下活动中担任指定代表。
+
+## 执行
+
+可以通过[联系维护者](mailto:zpj80231@163.com)报告辱骂、骚扰或其他不可接受的行为。所有投诉都将得到审查和调查，并产生被认为必要和适合情况的回应。项目团队有义务对事件报告人保密。
+
+## 归属
+
+本行为准则改编自[Contributor Covenant][homepage]，版本 1.4，可在 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 查看
@@ -0,0 +1,47 @@
+# 贡献指南
+
+感谢您有兴趣为本项目做贡献！在提交您的贡献之前，请务必花点时间阅读以下指南。
+
+## 行为准则
+
+本项目遵守[行为准则](CODE_OF_CONDUCT.md)。通过参与，您需要遵守该准则。请报告不可接受的行为到[维护者](mailto:zpj80231@163.com)。
+
+## 如何贡献
+
+### 提交 Issue
+
+- 在提交 issue 之前，请先搜索现有 issue，避免重复
+- 选择合适的 issue 模板（Bug 报告或功能请求）
+- 清晰准确地描述问题或需求
+
+### 提交代码
+
+1. Fork 项目并创建您的分支 (`git checkout -b feature/AmazingFeature`)
+2. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
+3. 推送到分支 (`git push origin feature/AmazingFeature`)
+4. 开启 Pull Request
+
+### 代码规范
+
+- 遵循项目现有的代码风格
+- 添加适当的注释说明复杂逻辑
+- 编写测试用例（如果适用）
+- 确保所有测试通过
+
+## Pull Request 规范
+
+- 保持 PR 聚焦于单一功能或修复
+- 在 PR 描述中清楚解释变更的目的和影响
+- 关联相关的 issue（如果有的话）
+- 确保 CI 检查通过
+
+## 代码审查流程
+
+所有提交的 PR 都会经过审查过程：
+
+1. 自动化检查（CI）
+2. 维护者人工审查
+3. 根据反馈进行修改
+4. 合并到主分支
+
+感谢您的贡献！