AhaKey 希望建设一个友好、开放、尊重创造的开发者社区。
我们欢迎不同背景的用户、开发者、创作者、学生、研究者和硬件爱好者参与 AhaKey 的共创。
这份文档适用于 AhaKey 相关的 GitHub Issues、Pull Requests、Discussions、社区项目、文档、社群讨论以及其他公开或半公开协作场景。
请尽量：
- 友好交流；
- 尊重不同经验水平的用户和开发者；
- 聚焦问题本身，而不是攻击个人；
- 清楚描述 bug、想法和反馈；
- 在提问前先简单阅读相关 README；
- 给出建设性建议；
- 尊重维护者的时间；
- 尊重原创项目和作者署名；
- 鼓励用户分享自己的 DIY、工具、教程和 workflow；
- 对实验性项目保持开放态度，同时清楚标注风险和限制。
AhaKey 社区不接受以下行为：
- 人身攻击、辱骂、骚扰、威胁；
- 歧视性、侮辱性或恶意言论；
- 故意刷屏、引战、恶意挑衅；
- 未经允许公开他人隐私信息；
- 恶意提交无关 Issue / PR；
- 冒充 AhaKey 官方成员、官方版本或官方发布渠道；
- 故意传播虚假信息，误导用户安装或使用非官方版本；
- 未经授权公开、转发、出售或共享受控源码、固件资料、硬件设计文件或生产资料；
- 使用 AhaKey 社区资料从事仿制、低价复制、恶意竞争或损害社区生态的行为；
- 其他破坏社区友好、开放、建设性氛围的行为。
AhaKey 鼓励开源共创，也鼓励用户基于公开协议和官方客户端进行二次开发。
但以下资料不默认公开：
- 固件源码；
- 硬件原理图、PCB、生产资料；
- 官方设备内部实现细节；
- 可用于仿制、打板、量产、销售的硬件资料。
未经授权，不得将受控资料公开上传、网络分发、转发、出售、共享，也不得用于自行打板、仿制、量产、销售或开发竞争性硬件产品。
如果你确实需要访问硬件嵌入式源码或固件资料，请通过官方申请入口提交申请：
如果你在 AhaKey 社区中遇到不合适的行为，可以联系维护团队：
Email: zhangxinyang@ahakey.cn
Subject: [AhaKey Community] 行为规范反馈
请尽量提供：
- 发生位置：Issue / PR / Discussion / 社群 / 其他；
- 相关链接；
- 简要说明；
- 截图或记录，如果有；
- 你希望我们如何协助处理。
我们会尽量认真查看反馈，并根据情况采取适当措施。
根据情况，维护者可能会采取以下措施：
- 提醒或警告；
- 请求修改表达方式；
- 隐藏或删除不合适内容；
- 关闭 Issue / PR / Discussion；
- 限制参与社区互动；
- 移除仓库或组织访问权限；
- 对严重违规行为保留进一步处理权利。
维护者会尽量以公平、克制、透明的方式处理社区问题。
AhaKey 欢迎探索、实验和不同意见。
但 AhaKey 社区应该保持友好、尊重、建设性，并共同保护开源共创生态。
AhaKey aims to build a friendly, open, and creative developer community.
We welcome users, developers, creators, students, researchers, and hardware enthusiasts from different backgrounds to participate in AhaKey collaboration.
This document applies to AhaKey-related GitHub Issues, Pull Requests, Discussions, community projects, documentation, community chats, and other public or semi-public collaboration spaces.
Please try to:
- communicate kindly;
- respect users and developers with different experience levels;
- focus on the issue, not the person;
- describe bugs, ideas, and feedback clearly;
- read relevant README files before asking questions;
- provide constructive suggestions;
- respect maintainers' time;
- respect original projects and author credits;
- encourage users to share their DIY projects, tools, tutorials, and workflows;
- stay open to experimental projects while clearly marking risks and limitations.
The following behavior is not acceptable in the AhaKey community:
- personal attacks, insults, harassment, or threats;
- discriminatory, offensive, or malicious language;
- spam, flame wars, or intentional provocation;
- publishing others' private information without permission;
- maliciously submitting unrelated Issues or PRs;
- impersonating official AhaKey members, official versions, or official release channels;
- spreading false information that misleads users into installing or using unofficial versions;
- publicly distributing, forwarding, selling, or sharing controlled source code, firmware materials, hardware design files, or production materials without authorization;
- using AhaKey community materials for cloning, low-cost copying, malicious competition, or behavior that harms the community ecosystem;
- any other behavior that damages a friendly, open, and constructive community environment.
AhaKey encourages open collaboration and secondary development based on public protocols and official client software.
However, the following materials are not public by default:
- firmware source code;
- schematics, PCB files, and production materials;
- internal implementation details of official devices;
- hardware materials that can be used for cloning, board reproduction, manufacturing, or resale.
Without authorization, controlled materials may not be publicly uploaded, redistributed, forwarded, sold, or shared. They may not be used for board reproduction, cloning, manufacturing, resale, or competing hardware development.
If you really need firmware or embedded source access, please submit a request through the official application page:
👉 AhaKey Hardware Source Access Request
If you encounter inappropriate behavior in the AhaKey community, please contact the maintainers:
Email: zhangxinyang@ahakey.cn
Subject: [AhaKey Community] Code of Conduct Report
Please include, if possible:
- where it happened: Issue / PR / Discussion / community chat / other;
- related links;
- a short description;
- screenshots or records, if available;
- how you would like us to help.
We will try to review reports carefully and take appropriate action.
Depending on the situation, maintainers may take actions such as:
- reminder or warning;
- requesting changes in wording or behavior;
- hiding or deleting inappropriate content;
- closing Issues, PRs, or Discussions;
- limiting community participation;
- removing repository or organization access;
- reserving further action for serious violations.
Maintainers will try to handle community issues in a fair, restrained, and transparent way.
AhaKey welcomes exploration, experimentation, and different opinions.
But the AhaKey community should remain friendly, respectful, constructive, and protective of the open collaboration ecosystem.