Skip to content

Commit f1e2afb

Browse files
committed
docs: Minor updates before 1.0.0
1 parent 63ade77 commit f1e2afb

File tree

4 files changed

+38
-18
lines changed

4 files changed

+38
-18
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# Contributing
2+
Please note that this project is released with a
3+
[Contributor Code of Conduct](https://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md).
4+
By participating in this project you agree to abide by its terms. Participation
5+
covers any forum used to converse about CircuitPython including unofficial and official spaces. Failure to do
6+
so will result in corrective actions such as time out or ban from the project.
27

3-
Please note that this project is released with a Contributor Code of
4-
Conduct. By participating in this project you agree to abide by its terms.
8+
## Developer contact
9+
[@tannewt](https://github.com/tannewt) is the main developer of CircuitPython
10+
and is sponsored by [Adafruit Industries LLC](https://adafruit.com). He is
11+
reachable on [Discord](https://adafru.it/discord) as tannewt and
12+
[Gitter](gitter.im/adafruit/circuitpython) as tannewt during US West Coast
13+
working hours. He also checks GitHub issues and the [Adafruit support forum](https://forums.adafruit.com/viewforum.php?f=60).
514

6-
https://github.com/adafruit/micropython/blob/master/CODE_OF_CONDUCT.md
15+
## Licensing
16+
By contributing to this repository you are certifying that you have all necessary
17+
permissions to license the code under an MIT License. You still retain the
18+
copyright but are granting many permissions under the MIT License.
719

8-
When reporting an issue and especially submitting a pull request, please
9-
make sure that you are acquainted with Contributor Guidelines:
20+
If you have an employment contract with your employer please make sure that they
21+
don't automatically own your work product. Make sure to get any necessary approvals
22+
before contributing. Another term for this contribution off-hours is moonlighting.
1023

11-
https://github.com/micropython/micropython/wiki/ContributorGuidelines
24+
## Code guidelines
25+
We aim to keep our code and commit style compatible with MicroPython upstream.
26+
Please review their
27+
[code conventions](https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md) to do so.
28+
Familiarity with their [design philosophy](https://github.com/micropython/micropython/wiki/ContributorGuidelines)
29+
is also useful though not always applicable to CircuitPython.
1230

13-
and Code Conventions:
14-
15-
https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md
31+
Furthermore, CircuitPython has a
32+
[design guide](https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html)
33+
that covers a variety of different topics. Please read it as well.

docs/common_hal.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,5 @@ The last step is actually implementing each function in a port specific way. I c
8383
### Testing
8484
Woohoo! You are almost done. After you implement everything, lots of drivers and sample code should just work. There are a number of drivers and examples written for Adafruit's Feather ecosystem. Here are places to start:
8585

86-
* https://github.com/adafruit?utf8=%E2%9C%93&q=Adafruit_MicroPython&type=&language=
86+
* [Adafruit repos with CircuitPython topic](https://github.com/search?q=topic%3Acircuitpython+org%3Aadafruit+fork%3Atrue)
87+
* [Adafruit driver bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle)

docs/design_guide.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ When adding extra functionality to CircuitPython to mimic what a normal
132132
operating system would do, either copy an existing CPython API (for example file
133133
writing) or create a separate module to achieve what you want. For example,
134134
mounting and unmount drives is not a part of CPython so it should be done in a
135-
module, such as a new ``filesystem``, that is only available in CircuitPython.
135+
module, such as a new ``storage`` module, that is only available in CircuitPython.
136136
That way when someone moves the code to CPython they know what parts need to be
137137
adapted.
138138

@@ -235,12 +235,13 @@ Renders as:
235235
Use BusDevice
236236
--------------------------------------------------------------------------------
237237

238-
BusDevice is an awesome foundational library that manages talking on a shared
239-
I2C or SPI device for you. The devices manage locking which ensures that a
240-
transfer is done as a single unit despite CircuitPython internals and, in the
241-
future, other Python threads. For I2C, the device also manages the device
242-
address. The SPI device, manages baudrate settings, chip select line and extra
243-
post-transaction clock cycles.
238+
[BusDevice](https://github.com/adafruit/Adafruit_CircuitPython_BusDevice) is an
239+
awesome foundational library that manages talking on a shared I2C or SPI device
240+
for you. The devices manage locking which ensures that a transfer is done as a
241+
single unit despite CircuitPython internals and, in the future, other Python
242+
threads. For I2C, the device also manages the device address. The SPI device,
243+
manages baudrate settings, chip select line and extra post-transaction clock
244+
cycles.
244245

245246
I2C Example
246247
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/drivers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ the ``lib/`` directory. Some drivers may not work without them.
3838
Helper Libraries
3939
-------
4040

41-
These libraries build on top of the low level APIS to simplify common tasks.
41+
These libraries build on top of the low level APIs to simplify common tasks.
4242

4343
.. toctree::
4444
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy