We welcome contributions from the community to help make this project even better. Here are a few guidelines to help make the process smooth for everyone.
- Bug Reports: If you find a bug, please create a detailed issue that includes:
- Steps to reproduce the issue
- Expected vs. actual behavior
- Relevant device and OS information
- Feature Requests: Suggest new features and enhancements with a clear description of the use case and potential implementation.
- Code Contributions: Follow the guidelines below to submit pull requests with code changes.
- Documentation Improvements: Help us improve the clarity or add missing details to the README, code comments, or other documentation.
- Style: Please adhere to common Swift coding conventions for readability and consistency. Testing: New code should be accompanied by tests to ensure correctness and prevent regressions.
- Documentation: Update documentation where necessary to reflect your changes.
- Fork the repository.
- Create a new branch with a descriptive name (feature/my-new-feature or bugfix/issue-description).
- Make your changes, including tests and documentation updates.
- Commit your changes with clear and descriptive commit messages.
- Push your branch to your fork.
- Submit a pull request from your fork to the main repository.
###Additional Notes
If you have a major change in mind, please open an issue first to discuss it to ensure it aligns with the project direction. Be patient with the review process. We value your contributions and will review them as soon as possible.
If you have any questions, feel free to open an issue or reach out to the maintainer(s).
Thank you for your interest in making SwiftOBD2 better!