贡献指南
参与 PyriteIDE 开发的流程和规范。
开发流程
1. Fork 仓库
在 GitHub 上 Fork 仓库并克隆到本地。
2. 创建分支
git checkout -b feature/my-feature分支命名规范:
feature/— 新功能fix/— 修复docs/— 文档refactor/— 重构
3. 开发
遵循项目的编码规范和架构设计。
4. 测试
flutter analyze --no-fatal-infos lib test
flutter test5. 提交
使用 Conventional Commit 风格:
feat: add more native view components
fix: fix the stdio issue
build!: modify application information使用 ! 标记破坏性变更。
6. PR
提交 Pull Request,包含:
- 简要说明变更内容
- 关联的 Issue
- 测试命令和结果
- 受影响的平台
- UI 变更的截图
编码规范
Dart
- 两空格缩进
- 使用
dart format . - PascalCase 命名类型
- lowerCamelCase 命名成员
- snake_case.dart 文件名
分析配置
项目使用 package:flutter_lints/flutter.yaml。修复分析发现的问题,不要抑制它们。
Provider 文件
Provider 文件命名清晰,如 *_provider.dart。
测试规范
暂时没有相关要求,请持续关注变更
提交规范
| 类型 | 说明 |
|---|---|
feat | 新功能 |
fix | 修复 |
docs | 文档 |
style | 格式(不影响代码含义) |
refactor | 重构(不新增功能或修复) |
test | 测试 |
chore | 构建或工具变更 |
build | 构建系统或外部依赖变更 |
破坏性变更使用 ! 后缀:build!: modify application information
安全
- 不要提交密钥、凭证或签名密钥
- 不要提交本地设备路径
- 保持子模块和本地依赖与
pubspec.yaml同步