Skip to content

Commit 82660f0

Browse files
Add contributing, issue template, and license docs
Introduces CONTRIBUTING.md with guidelines for contributors, ISSUE_TEMPLATE.md to standardize issue reporting, and LICENSE.md detailing hardware and software licensing terms for the project.
1 parent c4a4b91 commit 82660f0

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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_KX13X_Arduino_Library/issues) and [pull requests](https://github.com/sparkfun/SparkFun_KX13X_Arduino_Library/pulls) to see whether someone else has raised a similar idea or question.
6+
Please check the [closed issues](https://github.com/sparkfun/SparkFun_KX13X_Arduino_Library/issues?q=is%3Aissue+is%3Aclosed)
7+
and [closed pull requests](https://github.com/sparkfun/SparkFun_KX13X_Arduino_Library/pulls?q=is%3Apr+is%3Aclosed) too - you may find that your issue or feature has already been discussed.
8+
9+
If you decide to add a feature to this library, please create a PR and follow these best practices:
10+
11+
* Change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
12+
* 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_KX13X_Arduino_Library/tree/release_candidate). That way, we can merge and test your PR quickly without changing the _main_ branch
15+
16+
![Contributing.JPG](./img/Contributing.JPG)
17+
18+
## Style guide
19+
20+
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).

ISSUE_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Subject of the issue
2+
Describe your issue here. If you reference a datasheet please specify which one and in which section (ie, the protocol manual, section 5.1.2). Additionally, screenshots are easy to paste into github.
3+
4+
### Your workbench
5+
* What development board or microcontroller are you using?
6+
* What version of hardware or breakout board are you using?
7+
* How is the breakout board wired to your microcontroller?
8+
* How is everything being powered?
9+
* Are there any additional details that may help us help you?
10+
11+
### Steps to reproduce
12+
Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue.
13+
14+
### Expected behavior
15+
Tell us what should happen
16+
17+
### Actual behavior
18+
Tell us what happens instead

LICENSE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
SparkFun License Information
2+
============================
3+
4+
SparkFun uses two different licenses for our files — one for hardware and one for code.
5+
6+
Hardware
7+
---------
8+
9+
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10+
11+
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
12+
13+
You are free to:
14+
15+
Share — copy and redistribute the material in any medium or format
16+
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
17+
The licensor cannot revoke these freedoms as long as you follow the license terms.
18+
Under the following terms:
19+
20+
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
21+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
22+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
23+
24+
Notices:
25+
26+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
27+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
28+
29+
30+
Code
31+
--------
32+
33+
**SparkFun code, firmware, and software are released under the [MIT License](http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2025 SparkFun Electronics
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
40+
41+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
42+
43+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)