Skip to content

Commit 250ac44

Browse files
committed
Added CONTRIBUTING.md
1 parent eebe010 commit 250ac44

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### How to Contribute
2+
3+
Thank you so *much* for offering to help out. We truly appreciate it.
4+
5+
If you'd like to contribute, start by searching through the [issues](https://github.com/sparkfun/SparkFun_BNO080_Arduino_Library/issues) and [pull requests](https://github.com/sparkfun/SparkFun_BNO080_Arduino_Library/pulls) to see whether someone else has raised a similar idea or question.
6+
7+
If you decide to add a feature to this library, please create a PR following these best practices:
8+
9+
- Change as little as possible. Do not sumbit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
10+
- 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.
11+
- If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. [Read more](https://www.arduino.cc/en/Hacking/libraryTutorial).
12+
- Please submit your PR using the [release-candidate branch](https://github.com/sparkfun/SparkFun_BNO080_Arduino_Library/tree/release-candidate). That way, we can merge and test your PR quickly without changing the _master_ branch
13+
14+
## Style guide
15+
16+
Please read and follow the [Arduino API style guide](https://www.arduino.cc/en/Reference/APIStyleGuide). Also read and consider the [Arduino style guide](https://www.arduino.cc/en/Reference/StyleGuide).

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Repository Contents
2929
* **/src** - Source files for the library (.cpp, .h).
3030
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
3131
* **library.properties** - General library properties for the Arduino package manager.
32+
* **[CONTRIBUTING.md](https://github.com/sparkfun/SparkFun_BNO080_Arduino_Library/blob/master/CONTRIBUTING.md)** - guidance on how to contribute to this library.
3233

3334
Documentation
3435
--------------

0 commit comments

Comments
 (0)