LightTracker-1.0/libraries/SparkFun_Ublox_Arduino_Library/CONTRIBUTING.md

1.8 KiB
Executable File

How to Contribute

Thank you so much for offering to help out. We truly appreciate it.

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question. Please check the closed issues and closed pull requests too - you may find that your issue or feature has already been discussed.

If you decide to add a feature to this library, please create a PR and follow these best practices:

  • Change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
  • If you've added a new feature document it with a simple example sketch. This serves both as a test of your PR and as a quick way for users to quickly learn how to use your new feature.
  • If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. Read more.
  • Important: Please submit your PR using the release_candidate branch. That way, we can merge and test your PR quickly without changing the master branch

Contributing.JPG

Style guide

Please read and follow the Arduino API style guide. Also read and consider the Arduino style guide.