Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (49 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 2.33 KB

Contributing to Q1 nano | 贡献指南

Thank you for your interest in Q1 nano! We welcome contributions from everyone.

感谢你对 Q1 nano 的关注！我们欢迎所有形式的贡献。

🌟 How to Contribute | 如何贡献

Reporting Bugs | 报告问题

  • Use the Bug Report template
  • Include steps to reproduce, expected vs actual behavior
  • Attach logs, screenshots, or videos if applicable

Suggesting Features | 建议新功能

Submitting Code | 提交代码

  1. Fork the repository
  2. Create a branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes and commit with clear messages: 
    git commit -m "feat: add new walking gait parameter"
  4. Push to your fork and open a Pull Request

📐 Code Style | 代码规范

  • Python: Follow PEP 8. Use type hints where reasonable.
  • C/C++ (firmware): Use consistent indentation (4 spaces), descriptive variable names.
  • Documentation: Markdown format. Keep language clear and concise.

🔀 Pull Request Process | PR 流程

  1. Ensure your code compiles/runs without errors
  2. Update relevant documentation if needed
  3. Reference related issues in your PR description (e.g., Closes #12)
  4. One of the maintainers will review your PR — we aim to respond within 3 days

🏷️ Good First Issues | 新手友好任务

Look for issues labeled good first issue. These are great starting points:

  • 📝 Documentation improvements and translations
  • 🔧 RL training parameter tuning
  • 🎨 3D model improvements
  • 🧪 Adding simulation test cases

🗣️ Communication | 交流方式

  • GitHub Issues — bug reports, feature requests
  • GitHub Discussions — general questions, ideas, show & tell

📜 License | 许可协议

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

贡献代码即表示你同意你的贡献将以 Apache License 2.0 许可协议发布。