感谢你对 NeurolingsCE 的关注!本页面介绍如何参与项目开发。

Thank you for your interest in NeurolingsCE! This page explains how to contribute to the project.

建议先阅读以下文档:

• 架构概览 — 了解代码结构和核心类
• 构建指南 — 确保你可以本地编译
• 平台抽象层 — 如果涉及平台相关代码

• libshijima 引擎已集成 — 位于 src/app/core/shijima-engine/,可以直接修改。注意上游 libshijima 不接受外部贡献。
• libshimejifinder 和 cpp-httplib — 为只读子模块,修改请向对应的上游仓库提交。
• libshimejifinder 和 cpp-httplib — 同为只读子模块。
• 修改子模块代码请向对应的上游仓库提交。

git clone https://github.com/qingchenyouforcc/NeurolingsCE.git
cd NeurolingsCE
git submodule update --init --recursive

提交 PR 前确保至少在一个平台上可以编译通过:

# Windows (MSVC)
cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug -DQt6_DIR=<your-qt-path>
cmake --build build
# Linux / macOS
CONFIG=debug make -j$(nproc)

采用 "主体 + 职责" 的命名方式将大型类拆分为多个职责切片:

这种命名便于按文件名直接定位业务边界,避免单文件过大。新增功能时请遵循此模式。

项目没有 .clang-format 或 .clang-tidy 配置,请匹配现有代码风格:

// 平台判断
#ifdef WIN32 // Windows
#ifdef __linux__ // Linux
#ifdef __APPLE__ // macOS
// 功能开关
#if SHIJIMA_USE_QTMULTIMEDIA
#if SHIJIMA_WITH_SHIMEJIFINDER

• 不要 使用 C 风格强制转换
• 不要 压制类型错误
• 使用 static_cast<>, dynamic_cast<> 等 C++ 转换
• 使用 std::unique_ptr, std::shared_ptr 管理资源(参考 ShijimaWidget 中的 m_mascot)

在 GitHub 上 fork NeurolingsCE。

git checkout -b feature/my-feature
# 或
git checkout -b fix/my-bugfix

• 确保代码可在至少一个平台上编译
• 如果修改了平台相关代码,尽量在相关平台上测试
• 如果修改了 UI,确保中英文翻译都正确

git add .
git commit -m "描述你的修改"

建议的提交信息格式:

• feat: 添加 XXX 功能 — 新功能
• fix: 修复 XXX 问题 — Bug 修复
• refactor: 重构 XXX — 重构
• docs: 更新 XXX 文档 — 文档
• i18n: 更新 XXX 翻译 — 翻译

推送到 fork 后,在 GitHub 上创建 PR 到 main 分支。

PR 中请说明:

• 修改了什么
• 为什么要修改
• 如何测试

PR 会触发 CI 构建(build-debug.yaml),在 Windows、Linux (x86_64 + arm64)、macOS 上编译验证。

• 修复 Taskbar bug
• i18n 支持扩展

• Bug 修复 — 查看 Issues
• 新语言翻译 — 参见 国际化指南
• 文档改进 — 修正错误、添加示例
• 平台支持 — 改善 Linux 桌面环境兼容性
• 性能优化 — 精灵图渲染、内存使用

• GitHub Issues: 问题反馈
• 反馈 QQ 群: 423902950
• 交流 QQ 群: 125081756

如果你对 Neuro 社区项目开发感兴趣,可以联系作者加入 NeuForge Center。

• 架构概览
• 构建指南
• 国际化
• CI/CD