forked from micropython/micropython
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
38 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters