diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..04b8c54 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..90ba471 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# 贡献指南 + +欢迎为 MonkeyCode 项目做贡献!本指南将帮助你开始贡献代码。 + + +## 代码提交流程 + +1. 创建新的功能分支: +```bash +git checkout -b feat/your-feature-name +``` + +2. 提交代码前请确保: +- 已通过所有测试 +- 已格式化代码 +- 已更新相关文档 + +3. 创建 Pull Request: +- 确保 PR 有清晰的标题和描述 +- 关联相关 Issue +- 遵循 PR 模板要求 + +## 代码风格 + +1. **Go 代码**: +- 使用 gofmt 格式化代码 +- 遵循 effective go 指南 +- 保持函数简洁 (<80 行) + +2. **TypeScript 代码**: +- 使用 ESLint 检查代码 +- 遵循标准 React 实践 +- 使用 Prettier 格式化 + +## 测试要求 + +1. 后端: +- 所有主要功能应有单元测试 +- 覆盖率不应低于 80% +- 运行 `make test` 来执行测试 + +2. 前端: +- 组件应包含基本测试 +- 重要交互逻辑应有测试 +- 运行 `npm test` 来执行测试 + +## 其他指南 + +- 提交消息应清晰且有意义 +- 大功能实现应先创建设计文档 +- 问题讨论可以在 GitHub Issues 中进行 +- 遇到问题随时提问 diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..247e209 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,13 @@ +# 安全策略 + +## 受支持的版本 + +MonkeyCode 采用 rolling release 的方式进行发行,非最新版 release 中存在的安全问题不在本计划的考虑范围之内。 + +## 报告安全漏洞 +说明如何报告安全问题。建议使用私下报告方式(如 GitHub Security Advisory 或专用邮箱): + +1. **私下报告**:请通过 [GitHub Security Advisory](https://github.com/chaitin/MonkeyCode/security/advisories) 提交漏洞。 +2. 我们会在 **3 个工作日内**确认收到,并在 **7 天内**提供修复时间表。 +3. 修复完成后,我们会发布安全公告并感谢报告者(除非您希望匿名)。 +