Skip to content
This repository was archived by the owner on Jan 28, 2021. It is now read-only.

Commit 9d70657

Browse files
committed
Adding a contributing link to README
1 parent 5cc47d9 commit 9d70657

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### How to Contribute
1+
# How to Contribute
22

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

@@ -10,8 +10,8 @@ If you decide to add a feature to this library, please create a PR and follow th
1010

1111
* Change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
1212
* 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.
13-
* 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).
14-
* **Important:** Please submit your PR using the [release-candidate branch](https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library/tree/release_candidate). That way, we can merge and test your PR quickly without changing the _master_ branch
13+
* 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).
14+
* **Important:** Please submit your PR using the [release_candidate branch](https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library/tree/release_candidate). That way, we can merge and test your PR quickly without changing the _master_ branch
1515

1616
![Contributing.JPG](./img/Contributing.JPG)
1717

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,19 @@ Need a Python version for Raspberry Pi? Checkout the [Qwiic Ublox GPS Py module]
5353

5454
Need a library for the Ublox and Particle? Checkout the [Particle library](https://github.com/aseelye/SparkFun_Ublox_Particle_Library) fork.
5555

56+
Contributing
57+
--------------
58+
59+
If you would like to contribute to this library: please do, we truly appreciate it, but please follow [these guidelines](./CONTRIBUTING.md). Thanks!
60+
5661
Repository Contents
5762
-------------------
5863

5964
* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
6065
* **/src** - Source files for the library (.cpp, .h).
6166
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
6267
* **library.properties** - General library properties for the Arduino package manager.
68+
* **CONTRIBUTING.md** - Guidelines on how to contribute to this library.
6369

6470
Documentation
6571
--------------

0 commit comments

Comments
 (0)