
🚀 快速入口:
📘 新手指导手册 | 🛠️ 开发环境配置 | 🤝 参与共建 | 🧩 适配指导手册 | 🌱 贡献者成长路径 | 📦 仓颉三方库清单 | 🔧 适配 PR 模板 | 📄 文档 PR 模板
🌟 简介
AtomGit 仓颉社区致力于为广大开发者提供一个学习与共建的平台,沉淀系统化的仓颉学习资料与生态实践,包括三方库适配案例、应用案例与最佳实践,欢迎大家一起共建仓颉生态。
月底我们会陆续发布仓颉三方库大赛与仓颉三方库适配等活动,期待大家的参与和共建。
🤝 社区理念
- 🤝 开放共建:以开源方式协同演进,尊重并欢迎一切善意的改进提案。
- 📚 学习优先:通过成体系的学习资料与案例加速开发者成长。
- 🧪 实战导向:鼓励基于真实业务的适配与应用案例沉淀最佳实践。
- ♻️ 长期主义:以可持续的节奏维护生态质量、开发者体验与社区健康。
🎯 社区目标
- 📈 生态丰富度:推动更多高质量三方库完成仓颉适配与维护。
- 🎓 开发者成长:提供分层次学习路径与上手示例,降低入门与进阶门槛。
- 🧰 质量与规范:建立统一的代码规范、文档与版本发布流程,提升可维护性。
- 🌐 连接与影响:促进企业与个人开发者参与,形成良性循环的技术生态。
🏠 官网
https://cangjie-lang.cn/
🧭 仓颉源码
https://atomgit.com/cangjie
https://atomgit.com/cangjie-tpc
https://atomgit.com/cangjie-sig
📚 仓颉学习大纲
入门
- 语言基础:语法、类型系统、控制流、错误处理、模块化。
- 开发环境:编译器/工具链安装、项目结构、构建与运行。
- 标准库速览:常用集合、IO、并发/异步能力、时间与日期。
- 第一个应用:命令行/简单 Web 示例,理解构建与调试流程。
进阶
- 泛型与类型进阶:类型推断、约束、边界与常见范式。
- 并发与异步:协程/任务模型、通道/同步原语、性能考量。
- 错误与异常处理策略:可恢复与不可恢复错误、边界与规范。
- 模块与包管理:依赖管理、版本约束、语义化版本。
高级
- 性能优化:内存管理、数据结构选择、基准测试与剖析。
- FFI 与互操作:与 C/C++/系统库交互的模式与安全注意事项。
- 工程化实践:分层架构、领域建模、可测试性与可演进性。
- 安全与合规:依赖审计、许可证合规、安全编码规范。
实战
- 三方库适配:选型、裁剪、移植、API 对齐、测试与发布。
- Web/服务端:路由、序列化、持久化、配置与部署示例。
- 工具/CLI:参数解析、日志、配置文件、发行与分发。
- 多平台案例:Android/iOS/桌面端与生态工具链对接样例。
资源
- 📖 官方与社区:
官网、仓颉源码、SIG 小组与技术博客。
- 🧩 示例与模板:脚手架工程、最佳实践仓库清单。
- 🧭 学习清单:路线图、常见陷阱与习题库。
- 🆕 新手指南:参见《新手指导手册》。
⚡️ 快速贡献指南
贡献类型
- 📄 文档改进:纠错、补充示例、完善指南/FAQ/术语表。
- 🧩 三方库适配:新增/维护/升级已有适配,补齐测试与文档。
- 📘 示例与教程:端到端 Demo、教程、实验性验证。
- 🛠️ 生态工具:构建插件、LSP/格式化/静态检查等。
- 🧭 Issue 分拣:复现、最小化复现仓库、标记与合并重复议题。
- 🌐 翻译与本地化:中文/英文互译与术语统一。
- ✅ 测试与质量:单测/集成测试/基准测试与覆盖率提升。
- 📣 社区运营:发布日志、活动组织、月报与周报。
贡献流程
- 🔀 Fork/Clone 对应仓库;中型以上改动先创建
Issue 讨论。
- 🌱 分支命名:
feature/<scope>-<short>、fix/<scope>-<short>、docs/<scope>-<short>。
- 🧑💻 开发与规范:遵循代码风格与文档规范,补充必要测试与示例。
- 📝 提交信息:遵循
type(scope): subject,详见下方提交规范。
- 🔃 提 PR:填写变更说明、影响范围、测试方式与风险评估。
- 🔍 评审与修改:根据 Review 意见迭代,保持变更原子化、可读可测。
- 🎉 合并与致谢:合并后进入发布节奏,贡献者纳入致谢名录与激励统计。
模板与参考
代码与文档规范
- 提交信息示例:
feat(runtime): add async scheduler for IO-heavy tasks
- 分支与标签:配合语义化版本
MAJOR.MINOR.PATCH;变更记录放入 CHANGELOG。
- 目录结构:示例/文档/测试分层清晰;公共模块避免循环依赖。
- DCO/CLA:若仓库启用,请按机器人提示完成签署与校验。
贡献激励
- G-star 认证:高质量适配与维护者可获得认证与曝光资源。
- 积分/徽章:按 Issue/PR/文档贡献等维度累计,达标解锁等级徽章。
- 活动奖励:参与大赛与主题月活动可获得周边/奖金/培训名额等。
行为准则
- 遵循社区友善交流原则,尊重差异,拒绝人身攻击与歧视性言论。
- 坚持技术事实与证据,避免无根据的结论与传播。
🐞 问题反馈
常见问题(FAQ)
- 工具链安装失败:确认平台与版本要求;清理缓存后重试;附带日志。
- 版本兼容性:标注编译器/标准库/依赖版本;给出最小复现。
- 三方库适配问题:说明原库版本、接口差异、已尝试路径与阻塞点。
- 提交规范:参考上文提交信息与分支命名;不满足会要求补充。
贡献问题反馈模板
请在提 Issue 时尽量包含:
标题:<问题/提案简述>
环境:
- OS/CPU:
- 仓颉版本:
- 依赖/目标库版本:
复现步骤:
1.
2.
3.
预期结果:
实际结果:
最小复现仓库(可选):
附加信息/截图:
漏洞与安全披露
- 建议通过私有渠道先行披露(安全邮箱/表单),避免未修复前公开扩散。
- 披露内容建议包含影响范围、利用难度、复现步骤与缓解建议。
联系渠道
📈 社区实时指标数据
指标说明
- 📈 活跃度:提交次数、Issue/PR 打开与关闭速率、评审耗时。
- 🧩 生态增长:适配库数量、版本更新频次、示例/教程新增数。
- ⭐ 用户关注:Star/Fork/Watch、下载与使用量(如适用)。
🧩 三方库列表
🧩 大家可以从 Android、iOS、npm、Go、Rust 等平台查找并适配所需的三方库。按如下表格格式提交,审核通过后将获得激励、G-star 认证及更多支持。