mirror of
https://github.com/zhenxun-org/zhenxun_bot.git
synced 2025-12-14 13:42:56 +08:00
BalconyJH
GitHub
parent
af8f58b61e
commit
ee6170cd1b
87
CODE_OF_CONDUCT.md
Normal file
87
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,87 @@
|
||||
# zhenxun_bot 贡献者公约
|
||||
|
||||
## 我们的承诺
|
||||
|
||||
身为社区成员、贡献者和负责人，我们承诺使社区参与者不受骚扰，无论其年龄、体型、可见或不可见的缺陷、族裔、性征、性别认同和表达、经验水平、教育程度、社会与经济地位、国籍、相貌、种族、种姓、肤色、宗教信仰、性倾向或性取向如何。
|
||||
|
||||
我们承诺以有助于建立开放、友善、多样化、包容、健康社区的方式行事和互动。
|
||||
|
||||
## 我们的准则
|
||||
|
||||
有助于为我们的社区创造积极环境的行为例子包括但不限于：
|
||||
|
||||
* 表现出对他人的同情和善意
|
||||
* 尊重不同的主张、观点和感受
|
||||
* 提出和大方接受建设性意见
|
||||
* 承担责任并向受我们错误影响的人道歉
|
||||
* 注重社区共同诉求，而非个人得失
|
||||
|
||||
不当行为例子包括：
|
||||
|
||||
* 使用情色化的语言或图像，及性引诱或挑逗
|
||||
* 嘲弄、侮辱或诋毁性评论，以及人身或政治攻击
|
||||
* 公开或私下的骚扰行为
|
||||
* 未经他人明确许可，公布他人的私人信息，如物理或电子邮件地址
|
||||
* 其他有理由认定为违反职业操守的不当行为
|
||||
|
||||
## 责任和权力
|
||||
|
||||
社区负责人有责任解释和落实我们所认可的行为准则，并妥善公正地对他们认为不当、威胁、冒犯或有害的任何行为采取纠正措施。
|
||||
|
||||
社区负责人有权力和责任删除、编辑或拒绝或拒绝与本行为准则不相符的评论（comment）、提交（commits）、代码、维基（wiki）编辑、议题（issues）或其他贡献，并在适当时机知采取措施的理由。
|
||||
|
||||
## 适用范围
|
||||
|
||||
本行为准则适用于所有社区场合，也适用于在公共场所代表社区时的个人。
|
||||
|
||||
代表社区的情形包括使用官方电子邮件地址、通过官方社交媒体帐户发帖或在线上或线下活动中担任指定代表。
|
||||
|
||||
## 监督
|
||||
|
||||
辱骂、骚扰或其他不可接受的行为可通过 775757368@qq.com 向负责监督的社区负责人报告。
|
||||
所有投诉都将得到及时和公平的审查和调查。
|
||||
|
||||
所有社区负责人都有义务尊重任何事件报告者的隐私和安全。
|
||||
|
||||
## 处理方针
|
||||
|
||||
社区负责人将遵循下列社区处理方针来明确他们所认定违反本行为准则的行为的处理方式：
|
||||
|
||||
### 1. 纠正
|
||||
|
||||
**社区影响**：使用不恰当的语言或其他在社区中被认定为不符合职业道德或不受欢迎的行为。
|
||||
|
||||
**处理意见**：由社区负责人发出非公开的书面警告，明确说明违规行为的性质，并解释举止如何不妥。或将要求公开道歉。
|
||||
|
||||
### 2. 警告
|
||||
|
||||
**社区影响**：单个或一系列违规行为。
|
||||
|
||||
**处理意见**：警告并对连续性行为进行处理。在指定时间内，不得与相关人员互动，包括主动与行为准则执行者互动。这包括避免在社区场所和外部渠道中的互动。违反这些条款可能会导致临时或永久封禁。
|
||||
|
||||
### 3. 临时封禁
|
||||
|
||||
**社区影响**: 严重违反社区准则，包括持续的不当行为。
|
||||
|
||||
**处理意见**: 在指定时间内，暂时禁止与社区进行任何形式的互动或公开交流。在此期间，不得与相关人员进行公开或私下互动，包括主动与行为准则执行者互动。违反这些条款可能会导致永久封禁。
|
||||
|
||||
### 4. 永久封禁
|
||||
|
||||
**社区影响**：行为模式表现出违反社区准则，包括持续的不当行为、骚扰个人或攻击或贬低某个类别的个体。
|
||||
|
||||
**处理意见**：永久禁止在社区内进行任何形式的公开互动。
|
||||
|
||||
## 参见
|
||||
|
||||
本行为准则改编自 [Contributor Covenant][homepage] 2.1 版, 参见 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]。
|
||||
|
||||
社区处理方针灵感来源于 [Mozilla's code of conduct enforcement ladder][Mozilla CoC]。
|
||||
|
||||
有关本行为准则的常见问题的答案，参见 [https://www.contributor-covenant.org/faq][FAQ]。
|
||||
其他语言翻译参见 [https://www.contributor-covenant.org/translations][translations]。
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
95
CONTRIBUTING.md
Normal file
95
CONTRIBUTING.md
Normal file
@ -0,0 +1,95 @@
|
||||
# zhenxun_bot 贡献指南
|
||||
|
||||
首先，感谢你愿意为 zhenxun_bot 贡献自己的一份力量！
|
||||
|
||||
本指南旨在引导你更规范地向 zhenxun_bot 提交贡献，请务必认真阅读。
|
||||
|
||||
## 提交 Issue
|
||||
|
||||
在提交 Issue 前，我们建议你先查看 [已有的 Issues](https://github.com/HibiKier/zhenxun_bot/issues)，以防重复提交。
|
||||
|
||||
### 报告问题、故障与漏洞
|
||||
|
||||
如果你在使用过程中发现问题并确信是由 zhenxun_bot 引起的，欢迎提交 Issue。
|
||||
|
||||
请使用我们提供的 **Bug 反馈** 模板，并尽可能详细地描述：
|
||||
|
||||
- 问题描述
|
||||
- 重现步骤
|
||||
- 你的环境信息（如操作系统、依赖版本等）
|
||||
|
||||
### 建议功能
|
||||
|
||||
如果你有新的功能需求或改进建议，欢迎提出。
|
||||
|
||||
请使用 **功能建议** 模板，并详细描述你所需要的特性，可能的话可以提出你认为可行的解决方案。
|
||||
|
||||
### 文档相关
|
||||
|
||||
如果你觉得文档有误或缺乏更新，欢迎提出。
|
||||
|
||||
请使用 **文档改进** 模板，并详细描述问题或主题，希望我们做出的修改
|
||||
|
||||
## Pull Request
|
||||
|
||||
### 分支管理
|
||||
|
||||
请从 `main` 分支创建新功能分支，例如：
|
||||
|
||||
- 新功能：`feature/功能描述`
|
||||
- 问题修复：`bugfix/问题描述`
|
||||
|
||||
### 代码风格
|
||||
|
||||
zhenxun_bot 使用 `pre-commit` 进行代码格式化和检查，请在提交前确保代码通过检查。
|
||||
|
||||
```bash
|
||||
# 在安装项目依赖后安装 pre-commit 钩子
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
> 未通过 `pre-commit` 检查的代码将无法合并。
|
||||
|
||||
### Commit 规范
|
||||
|
||||
请确保你的每一个 commit 都能清晰地描述其意图，一个 commit 尽量只有一个目的。
|
||||
|
||||
我们建议遵循 [gitmoji](https://gitmoji.dev/) 的 commit message 格式，在创建 commit 时请牢记这一点。
|
||||
|
||||
### 工作流程概述
|
||||
|
||||
`main` 分支为 zhenxun_bot 的主分支，在任何情况下都请不要直接修改 `main` 分支，而是创建一个目标分支为 `main` 的 Pull Request 来提交修改。Pull Request 标题请尽量清晰，以便维护者进行审核。
|
||||
|
||||
如果你不是 zhenxun_bot 团队的成员，可在 fork 本仓库后，向本仓库的 `main` 分支发起 Pull Request，注意遵循先前提到的 commit message 规范创建 commit。我们将在 code review 通过后合并你的贡献。
|
||||
|
||||
### 撰写文档
|
||||
|
||||
如果你对文档有改进建议，欢迎提交 Pull Request 或者 Issue。
|
||||
|
||||
[//]: # (我们使用 Markdown 编写文档，建议遵循以下规范：)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (1. 中文与英文、数字、半角符号之间需要有空格。例：`zhenxun_bot 是一个高效的聊天机器人。`)
|
||||
|
||||
[//]: # (2. 若非英文整句，使用全角标点符号。例：`现在你可以看到机器人回复你：“Hello，世界！”。`)
|
||||
|
||||
[//]: # (3. 直引号`「」`和弯引号`“”`都可接受，但同一份文件里应使用同种引号。)
|
||||
|
||||
[//]: # (4. **不要使用斜体**，你不需要一种与粗体不同的强调。)
|
||||
|
||||
[//]: # (5. 文档中应以“我们”指代开发者，以“用户”指代机器人的使用者。)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (如果你需要编辑器检查 Markdown 规范，可以在 VSCode 中安装 `markdownlint` 扩展。)
|
||||
|
||||
### 参与开发
|
||||
|
||||
zhenxun_bot 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 规范，请确保你的代码风格和项目已有的代码保持一致，变量命名清晰，有适当的注释与测试代码。
|
||||
|
||||
> 暂未搭建测试框架，因此暂不要求添加测试代码。
|
||||
|
||||
## 项目沟通
|
||||
|
||||
如有关于贡献流程的疑问或需要进一步指导，请通过 [QQ群](https://jq.qq.com/?_wv=1027&k=u8PgBkMZ) 联系我们。
|
||||
|
||||
再次感谢你的贡献！
|
||||
Loading…
Reference in New Issue
Block a user