Contributing to TrailCurrent

Thank you for your interest in contributing to TrailCurrent! This guide applies to all repositories in the trailcurrentoss organization.

Getting Started

1. Fork the repository you want to contribute to
2. Clone your fork locally
3. Create a branch for your changes (git checkout -b feature/your-feature)
4. Make your changes and test them
5. Commit with a clear message describing the change
6. Push to your fork and open a Pull Request

Types of Contributions

Bug Reports

• Use the Bug Report issue template
• Include steps to reproduce the issue
• Include your environment details (OS, hardware, firmware version)
• Attach logs or screenshots if applicable

Feature Requests

• Use the Feature Request issue template
• Describe the problem your feature would solve
• Explain your proposed solution

Code Contributions

• Follow the existing code style in the repository
• Keep changes focused and minimal
• Update documentation if your change affects usage
• Test your changes before submitting

Documentation

• Fix typos, clarify instructions, improve examples
• Documentation PRs are always welcome

Project-Specific Setup

Firmware Projects (ESP32 / PlatformIO)

• Install PlatformIO (CLI or VS Code extension)
• Clone the TrailCurrentKiCADLibraries repo if building hardware projects
• See each project's README for specific build instructions

Cloud / InVehicleCompute (Docker)

• Install Docker and Docker Compose
• See the project README for environment setup and configuration

Android App

• Install Android Studio with Kotlin support
• See the project README for build instructions

Code Review

All submissions require review before merging. Expect feedback within a few days. We may suggest changes, improvements, or alternatives.

Licensing

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

Questions?

Open an issue in the relevant repository or in TrailCurrentDocumentation for general questions.