Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.79 KB
Raw

Contributing to CarlaAir

Thank you for your interest in contributing to CarlaAir! We welcome contributions of all kinds — bug reports, feature requests, documentation improvements, and code contributions.

Getting Started

  1. Fork the repository and clone your fork
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name
  3. Make your changes and test them
  4. Commit and push to your fork
  5. Open a Pull Request

Commit Messages

We follow the Conventional Commits format:

Type Description
feat New feature
fix Bug fix
docs Documentation only
refactor Code refactoring (no feature change)
test Adding or updating tests
chore Build, CI, or tooling changes

Example: feat: add multi-drone spawn support

Issues

  • Bug reports: Use the [Bug] prefix in the title and include steps to reproduce, expected vs. actual behavior, and your environment (OS, Python version, etc.)
  • Feature requests: Use the [Feature] prefix and describe the use case

Pull Requests

  • Keep PRs focused — one feature or fix per PR
  • Use branch naming: feature/xxx, fix/xxx, docs/xxx
  • Include a clear description of what changed and why
  • Reference related issues (e.g., Closes #12)

Development Environment

# Clone and set up
git clone git@github.com:louiszengCN/CarlaAir.git
cd CarlaAir

# Set up Python environment
bash env_setup/setup_env.sh
conda activate carlaAir
bash env_setup/test_env.sh

Code of Conduct

Please be respectful and constructive in all interactions. We are committed to providing a welcoming and inclusive experience for everyone.

License

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