Skip to content

Commit

Permalink
Add more guidelines to contributing policy
Browse files Browse the repository at this point in the history
  • Loading branch information
bennuttall committed Feb 11, 2016
1 parent 0bc1683 commit 7e2b002
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Contributing

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
for all purposes. It is intended to provide a simple interface to everyday
components.
It is intended to provide a simple interface to everyday components.

If a proposed change added an advanced feature but made basic usage more
complex, it is unlikely to be added.

## 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
reasoning clearly.

Expand All @@ -23,11 +22,22 @@ problem clearly using code examples.
## Documentation

The documentation source lives in the
[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/).
[docs](https://github.com/RPi-Distro/python-gpiozero/tree/master/docs) folder.
Contributions to the documentation are welcome but should be easy to read and
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 2/3 compatibility
Expand Down

0 comments on commit 7e2b002

Please sign in to comment.