summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorScott Shawcroft <scott@chickadee.tech>2017-07-19 15:11:19 -0400
committerScott Shawcroft <scott@chickadee.tech>2017-07-19 15:13:23 -0400
commitbd4a9755300287de8cf66f917d8f9dd2b59109f2 (patch)
tree78f845380c734d0bd35335b63f52b1539b50a41b /CONTRIBUTING.md
parent0d2c1bf2bb130e5ddf7913165e6ae873a723dcf7 (diff)
docs: Minor updates before 1.0.0
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md36
1 files changed, 27 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 53429edc7..5401892dd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,33 @@
# Contributing
+Please note that this project is released with a
+[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md).
+By participating in this project you agree to abide by its terms. Participation
+covers any forum used to converse about CircuitPython including unofficial and official spaces. Failure to do
+so will result in corrective actions such as time out or ban from the project.
-Please note that this project is released with a Contributor Code of
-Conduct. By participating in this project you agree to abide by its terms.
+## Developer contact
+[@tannewt](https://github.com/tannewt) is the main developer of CircuitPython
+and is sponsored by [Adafruit Industries LLC](https://adafruit.com). He is
+reachable on [Discord](https://adafru.it/discord) as tannewt and
+[Gitter](gitter.im/adafruit/circuitpython) as tannewt during US West Coast
+working hours. He also checks GitHub issues and the [Adafruit support forum](https://forums.adafruit.com/viewforum.php?f=60).
-https://github.com/adafruit/micropython/blob/master/CODE_OF_CONDUCT.md
+## Licensing
+By contributing to this repository you are certifying that you have all necessary
+permissions to license the code under an MIT License. You still retain the
+copyright but are granting many permissions under the MIT License.
-When reporting an issue and especially submitting a pull request, please
-make sure that you are acquainted with Contributor Guidelines:
+If you have an employment contract with your employer please make sure that they
+don't automatically own your work product. Make sure to get any necessary approvals
+before contributing. Another term for this contribution off-hours is moonlighting.
-https://github.com/micropython/micropython/wiki/ContributorGuidelines
+## Code guidelines
+We aim to keep our code and commit style compatible with MicroPython upstream.
+Please review their
+[code conventions](https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md) to do so.
+Familiarity with their [design philosophy](https://github.com/micropython/micropython/wiki/ContributorGuidelines)
+is also useful though not always applicable to CircuitPython.
-and Code Conventions:
-
-https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md
+Furthermore, CircuitPython has a
+[design guide](https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html)
+that covers a variety of different topics. Please read it as well.