Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.9 KB

Contributing to ToStore

English | 中文

English

How to Contribute

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Guidelines

  • Follow Dart's style guide
  • Write clear commit messages
  • Add tests for new features
  • Update documentation when needed
  • Keep performance in mind

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the version numbers following Semantic Versioning

Code Style

  • Use dart format before committing
  • Follow the Effective Dart guidelines
  • Keep code clean and maintainable

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Include performance tests for critical components

中文

如何贡献

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m '添加某个特性')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 提交 Pull Request

开发指南

  • 遵循 Dart 代码风格指南
  • 编写清晰的提交信息
  • 为新功能添加测试
  • 及时更新文档
  • 注意性能优化

Pull Request 流程

  1. 如有必要，更新 README.md
  2. 遵循语义化版本更新版本号

代码风格

  • 提交前使用 dart format 格式化代码
  • 遵循 Effective Dart 指南
  • 保持代码整洁和可维护性

测试

  • 为新功能编写单元测试
  • 提交 PR 前确保所有测试通过
  • 为关键组件包含性能测试

Thank you for contributing to ToStore! 感谢您为 ToStore 做出贡献！