Update contributing guidelines

This commit is contained in:
Ben Nuttall
2016-12-08 17:26:09 +00:00
parent 5a1ee73164
commit ea4ed9ad8c

View File

@@ -4,11 +4,7 @@
Contributing Contributing
============ ============
This module was designed for use in education; particularly for young children. Contributions to the library are welcome! Here are some guidelines to follow.
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 Suggestions
=========== ===========
@@ -33,8 +29,13 @@ Commit messages and pull requests
Commit messages should be concise but descriptive, and in the form of a patch 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 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 LED example").
phrase "fix #123" where ``#123`` is the issue number.
Commits which close (or intend to close) an issue should include the phrase
"fix #123" or "close #123" where ``#123`` is the issue number, as well as
include a short description, for example: "Add LED example, close #123", and
pull requests should aim to match or closely match the correspoding issue
title.
Backwards compatibility Backwards compatibility
======================= =======================
@@ -42,11 +43,12 @@ Backwards compatibility
Since this library reached v1.0 we aim to maintain backwards-compatibility Since this library reached v1.0 we aim to maintain backwards-compatibility
thereafter. Changes which break backwards-compatibility will not be accepted. thereafter. Changes which break backwards-compatibility will not be accepted.
Python Python 2/3
====== ==========
* Python 2/3 compatibility The library is 100% compatible with both Python 2 and 3. We intend to drop
* PEP8-compliance (with exceptions) Python 2 support in 2020 when Python 2 reaches `end-of-life`_.
.. _docs: https://github.com/RPi-Distro/python-gpiozero/tree/master/docs .. _docs: https://github.com/RPi-Distro/python-gpiozero/tree/master/docs
.. _issue: https://github.com/RPi-Distro/python-gpiozero/issues .. _issue: https://github.com/RPi-Distro/python-gpiozero/issues
.. _end-of-life: http://legacy.python.org/dev/peps/pep-0373/