Contributing

Contributing

Thank you for your interest in contributing to UltraLog!

Quick Start

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (cargo test)
5. Commit (git commit -m 'feat: add amazing feature')
6. Push (git push origin feature/amazing-feature)
7. Open a Pull Request

Full Contributing Guide

For complete contributing guidelines, see CONTRIBUTING.md in the repository.

The full guide covers:

• Setting up your development environment
• Development workflow
• Pull request process
• Coding standards
• Commit message guidelines
• Testing requirements
• Adding new ECU support

Types of Contributions

Type	Description
Bug Fixes	Fix reported issues
New Features	Add new functionality
ECU Support	Add support for new ECU formats
Documentation	Improve README, wiki, or code comments
Tests	Add or improve test coverage
Performance	Optimize parsing or rendering

Finding Issues

• good first issue - Great for first-time contributors
• help wanted - Issues where we need help

Before You Start

1. Check existing issues - Someone may already be working on it
2. Open an issue first - Discuss proposed changes before starting significant work
3. Get feedback - Wait for maintainer input on large changes

Commit Message Format

type(scope): short description

Longer description if needed.

Fixes #123

Types: feat, fix, docs, style, refactor, perf, test, chore

Pull Request Checklist

• Code compiles (cargo build)
• Tests pass (cargo test)
• Code is formatted (cargo fmt)
• No clippy warnings (cargo clippy -- -D warnings)
• Documentation updated if needed

Code of Conduct

Be respectful, constructive, and welcoming to all contributors.

---

Next Steps

• Development - Development setup and architecture
• FAQ - Common questions
• GitHub Issues - Report bugs or request features