|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing to UltraLog! |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +1. Fork the repository |
| 8 | +2. Create a feature branch (`git checkout -b feature/amazing-feature`) |
| 9 | +3. Make your changes |
| 10 | +4. Run tests (`cargo test`) |
| 11 | +5. Commit (`git commit -m 'feat: add amazing feature'`) |
| 12 | +6. Push (`git push origin feature/amazing-feature`) |
| 13 | +7. Open a Pull Request |
| 14 | + |
| 15 | +## Full Contributing Guide |
| 16 | + |
| 17 | +For complete contributing guidelines, see [CONTRIBUTING.md](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md) in the repository. |
| 18 | + |
| 19 | +The full guide covers: |
| 20 | + |
| 21 | +- [Setting up your development environment](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#getting-started) |
| 22 | +- [Development workflow](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#development-workflow) |
| 23 | +- [Pull request process](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#pull-request-process) |
| 24 | +- [Coding standards](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#coding-standards) |
| 25 | +- [Commit message guidelines](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#commit-guidelines) |
| 26 | +- [Testing requirements](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#testing) |
| 27 | +- [Adding new ECU support](https://github.com/SomethingNew71/UltraLog/blob/main/CONTRIBUTING.md#adding-ecu-support) |
| 28 | + |
| 29 | +## Types of Contributions |
| 30 | + |
| 31 | +| Type | Description | |
| 32 | +|------|-------------| |
| 33 | +| Bug Fixes | Fix reported issues | |
| 34 | +| New Features | Add new functionality | |
| 35 | +| ECU Support | Add support for new ECU formats | |
| 36 | +| Documentation | Improve README, wiki, or code comments | |
| 37 | +| Tests | Add or improve test coverage | |
| 38 | +| Performance | Optimize parsing or rendering | |
| 39 | + |
| 40 | +## Finding Issues |
| 41 | + |
| 42 | +- [`good first issue`](https://github.com/SomethingNew71/UltraLog/labels/good%20first%20issue) - Great for first-time contributors |
| 43 | +- [`help wanted`](https://github.com/SomethingNew71/UltraLog/labels/help%20wanted) - Issues where we need help |
| 44 | + |
| 45 | +## Before You Start |
| 46 | + |
| 47 | +1. **Check existing issues** - Someone may already be working on it |
| 48 | +2. **Open an issue first** - Discuss proposed changes before starting significant work |
| 49 | +3. **Get feedback** - Wait for maintainer input on large changes |
| 50 | + |
| 51 | +## Commit Message Format |
| 52 | + |
| 53 | +``` |
| 54 | +type(scope): short description |
| 55 | +
|
| 56 | +Longer description if needed. |
| 57 | +
|
| 58 | +Fixes #123 |
| 59 | +``` |
| 60 | + |
| 61 | +**Types:** `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore` |
| 62 | + |
| 63 | +## Pull Request Checklist |
| 64 | + |
| 65 | +- [ ] Code compiles (`cargo build`) |
| 66 | +- [ ] Tests pass (`cargo test`) |
| 67 | +- [ ] Code is formatted (`cargo fmt`) |
| 68 | +- [ ] No clippy warnings (`cargo clippy -- -D warnings`) |
| 69 | +- [ ] Documentation updated if needed |
| 70 | + |
| 71 | +## Code of Conduct |
| 72 | + |
| 73 | +Be respectful, constructive, and welcoming to all contributors. |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## Next Steps |
| 78 | + |
| 79 | +- [[Development]] - Development setup and architecture |
| 80 | +- [[FAQ]] - Common questions |
| 81 | +- [GitHub Issues](https://github.com/SomethingNew71/UltraLog/issues) - Report bugs or request features |
0 commit comments