mirror of
				https://github.com/KevinMidboe/python-gpiozero.git
				synced 2025-10-29 17:50:37 +00:00 
			
		
		
		
	| @@ -1,44 +0,0 @@ | ||||
| # Contributing | ||||
|  | ||||
| This module was designed for use in education; particularly for young children. | ||||
| 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 for additional components or enhancements to the | ||||
| codebase by opening an | ||||
| [issue](https://github.com/RPi-Distro/python-gpiozero/issues) explaining your | ||||
| reasoning clearly. | ||||
|  | ||||
| ## Bugs | ||||
|  | ||||
| Please submit bug reports by opening an | ||||
| [issue](https://github.com/RPi-Distro/python-gpiozero/issues) explaining the | ||||
| problem clearly using code examples. | ||||
|  | ||||
| ## Documentation | ||||
|  | ||||
| The documentation source lives in the | ||||
| [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-compatibility | ||||
| thereafter. Changes which break backwards-compatibility will not be accepted. | ||||
|  | ||||
| ## Python | ||||
|  | ||||
| - Python 2/3 compatibility | ||||
| - PEP8-compliance (with exceptions) | ||||
| @@ -100,7 +100,7 @@ Contributors | ||||
| .. _GitHub: https://github.com/RPi-Distro/python-gpiozero | ||||
| .. _issues: https://github.com/RPi-Distro/python-gpiozero/issues | ||||
| .. _recipes: http://gpiozero.readthedocs.io/en/latest/recipes.html | ||||
| .. _Contribute: CONTRIBUTING.md | ||||
| .. _contribute: http://gpiozero.readthedocs.io/en/latest/contributing.html | ||||
| .. _Ben Nuttall: https://github.com/bennuttall | ||||
| .. _Dave Jones: https://github.com/waveform80 | ||||
| .. _Martin O'Hanlon: https://github.com/martinohanlon | ||||
|   | ||||
							
								
								
									
										52
									
								
								docs/contributing.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								docs/contributing.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,52 @@ | ||||
| .. _contributing: | ||||
|  | ||||
| ============ | ||||
| Contributing | ||||
| ============ | ||||
|  | ||||
| This module was designed for use in education; particularly for young children. | ||||
| 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 for additional components or enhancements to the | ||||
| codebase by opening an `issue`_ explaining your reasoning clearly. | ||||
|  | ||||
| Bugs | ||||
| ==== | ||||
|  | ||||
| Please submit bug reports by opening an `issue`_ explaining the problem clearly | ||||
| using code examples. | ||||
|  | ||||
| Documentation | ||||
| ============= | ||||
|  | ||||
| The documentation source lives in the `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-compatibility | ||||
| thereafter. Changes which break backwards-compatibility will not be accepted. | ||||
|  | ||||
| Python | ||||
| ====== | ||||
|  | ||||
| * Python 2/3 compatibility | ||||
| * PEP8-compliance (with exceptions) | ||||
|  | ||||
| .. _docs: https://github.com/RPi-Distro/python-gpiozero/tree/master/docs | ||||
| .. _issue: https://github.com/RPi-Distro/python-gpiozero/issues | ||||
| @@ -8,6 +8,7 @@ Table of Contents | ||||
|  | ||||
|     recipes | ||||
|     notes | ||||
|     contributing | ||||
|     api_input | ||||
|     api_output | ||||
|     api_spi | ||||
| @@ -19,3 +20,4 @@ Table of Contents | ||||
|     api_exc | ||||
|     changelog | ||||
|     license | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user