KevinMidboe/python-gpiozero
1
0
Fork 0
mirror of https://github.com/KevinMidboe/python-gpiozero.git synced 2025-10-29 17:50:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more guidelines to contributing policy

Browse Source
This commit is contained in:
Ben Nuttall
2016-02-11 21:17:24 +00:00
parent 0bc16837d3
commit 7e2b002d2f
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@@ -1,16 +1,15 @@
# Contributing # Contributing
This module was designed for use in education; particularly for young children. This module was designed for use in education; particularly for young children.
It is not intended to replace `RPi.GPIO` and it does not claim to be suitable It is intended to provide a simple interface to everyday components.
for all purposes. It is intended to provide a simple interface to everyday
components.
If a proposed change added an advanced feature but made basic usage more If a proposed change added an advanced feature but made basic usage more
complex, it is unlikely to be added. complex, it is unlikely to be added.
## Suggestions ## Suggestions
Please make suggestions by opening an Please make suggestions for additional components or enhancements to the
codebase by opening an
[issue](https://github.com/RPi-Distro/python-gpiozero/issues) explaining your [issue](https://github.com/RPi-Distro/python-gpiozero/issues) explaining your
reasoning clearly. reasoning clearly.
@@ -23,11 +22,22 @@ problem clearly using code examples.
## Documentation ## Documentation
The documentation source lives in the The documentation source lives in the
[docs](https://github.com/RPi-Distro/python-gpiozero/tree/master/docs) folder [docs](https://github.com/RPi-Distro/python-gpiozero/tree/master/docs) folder.
and is rendered from markdown into HTML using [mkdocs](http://www.mkdocs.org/).
Contributions to the documentation are welcome but should be easy to read and Contributions to the documentation are welcome but should be easy to read and
understand. understand.
## Commit messages and pull requests
Commit messages should be concise but descriptive, and in the form of a patch
description, i.e. instructional not past tense ("Add LED example" not "Added
LED example"). Commits that close (or intend to close) an issue should use the
phrase "fix #123" where `#123` is the issue number.
## Backwards compatibility
Since this library reached v1.0 we aim to maintain backwards-compatability
thereafter. Changes which break backwards-compatability will not be accepted.
## Python ## Python
- Python 2/3 compatibility - Python 2/3 compatibility