Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.76 KB

Contributing to 8 Phoenix / 参与贡献 “八凤”

First off, thank you for considering contributing to 8 Phoenix! It is people like you who will help break the "AI wall" and build an open future for high-performance silicon.

首先，感谢您考虑为“八凤”项目做出贡献！正是像您这样的人在帮助打破“AI 算力墙”，为高性能芯片构建一个开放的未来。

🛠 Areas Where We Need Help / 我们需要的帮助

We are looking for experts and enthusiasts in the following domains: 我们正在寻找以下领域的专家和爱好者：

  1. Hardware (RTL): Verilog/Chisel implementation of the 512x512 Systolic Array. 硬件 (RTL): 512x512 脉动阵列的 Verilog/Chisel 实现。
  2. Photonics: Designing the optical handshake protocol for the Phoenix-Link. 光子学: 为 Phoenix-Link 设计光物理层握手协议。
  3. Compiler: Extending MLIR/LLVM to support the 8P-Matrix ISA. 编译器: 扩展 MLIR/LLVM 以支持 8P-Matrix 指令集。
  4. Documentation: Translating technical specs and writing tutorials in English and Chinese. 文档: 翻译技术规范并编写中英双语教程。

📜 Contribution Rules / 贡献准则

1. Bilingual Support / 双语支持

  • English: All code comments and documentation should ideally be in English for global compatibility.
  • 中文: 我们同样欢迎中文文档和Issue讨论。请确保关键技术术语的准确性。
  • Commit Messages: Please use English for commit messages (e.g., feat: add systolic array logic).

2. Code Quality / 代码质量

  • All Hardware designs must be accompanied by a testbench.
  • 所有硬件设计必须附带测试平台 (Testbench)。
  • Follow the Google C++ Style Guide for simulator code.

🚀 How to Submit a Change / 如何提交更改

  1. Fork the repository on GitHub. 在 GitHub 上 Fork 本仓库。
  2. Create a branch for your feature (git checkout -b feature/amazing-feature). 为您的特性创建分支。
  3. Commit your changes (git commit -m 'feat: add some amazing feature'). 提交您的更改。
  4. Push to the branch (git push origin feature/amazing-feature). 推送至该分支。
  5. Open a Pull Request. 开启一个 Pull Request。

💬 Community / 社区交流

  • GitHub Issues: For bug reports and feature requests.
  • Discussions: For architectural debates and "What if" ideas.

By contributing, you agree that your contributions will be licensed under the project's Apache 2.0 License. 通过参与贡献，您同意您的贡献将基于项目的 Apache 2.0 开源协议进行授权。

Fly high, Phoenix! / 凤凰翱翔，志在千里。