5 ‐ Contributing

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.

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

• Change as little as possible. Do not sumbit 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.
• Please submit your PR using the [release_candidate branch]. That way, we can merge and test your PR quickly without changing the master branch

Issue template

Subject of the issue

Describe your issue here. Your workbench

• What development board or microcontroller are you using?
• What version of hardware or breakout board are you using?
• How is the breakout board connected to your microcontroller?
• How is everything being powered?
• Are there any additional details that may help us help you?

Steps to reproduce

Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue.

Expected behavior

Tell us what should happen

Actual behavior

Tell us what happens instead