Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.24 KB
Raw

Logo

Contributing to iRacingRPC

Thank you for considering contributing to iRacingRPC. It's people like you that make iRacingRPC such a great tool. This guide should cover the basics of contribution guidelines.

The iRacing telemetry data can be found here in PDF format.

Reporting Bugs

  • Use the issue tracker to report bugs.

  • Describe the bug in as much detail as possible, including steps to reproduce it, the expected outcome, and the actual outcome.

  • Include screenshots if relevant.

  • Trying to find bugs? Feel free to try to break absolutely everything without modifying the code itself.

Suggesting Enhancements

  • Use the issue tracker to suggest enhancements.
  • Be clear about what you're suggesting and why you think it would be beneficial.

Pull Requests

  • Make sure your code adheres to the project's coding conventions (if specified).
  • Write meaningful commit messages.
  • Include comments in your code where necessary.
  • Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters.

Thank you for contributing to iRacingRPC!