Contributing

Thanks for contributing to DBC Utility. This page is a clean, web-friendly version of the repo's CONTRIBUTING.md.

Code of Conduct

Please read and follow the Code of Conduct.

How you can contribute

Report bugs

• Use the issue tracker on GitHub.
• Include a clear title and steps to reproduce.
• Add OS + version, Python version, and DBC Utility version.
• Attach sample DBC files/logs/screenshots when possible.

Suggest enhancements

• Describe the feature and why it helps.
• Include examples/mockups if relevant.

Pull requests

• Fork the repository and create a feature branch.
• Keep changes focused and well described.
• Update docs when behavior changes.

Development setup

Prerequisites

• Python 3.9+
• Git
• UV package manager (recommended)

Install & run

git clone https://github.com/busaudit/dbcUtility.git
cd dbcUtility
pip install uv
uv sync
uv run dbcUtility

Coding standards

• Follow PEP 8 style guidelines.
• Use clear names and add docstrings for public functions/classes.
• Separate UI logic from business logic where possible.
• Handle Qt signals/slots cleanly and avoid leaking resources.

Pull request process

1. Create a branch from main.
2. Make changes + test manually.
3. Update documentation if needed.
4. Submit a PR with a clear description and screenshots if UI changed.

License

By contributing, you agree your contributions are licensed under GPL v3. See License.