Skip to content

Commit 6156813

Browse files
author
Martin O'Hanlon
committed
github docs
1 parent 3940083 commit 6156813

File tree

4 files changed

+83
-0
lines changed

4 files changed

+83
-0
lines changed
File renamed without changes.

.github/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Contributions to the picozero are welcome. Here is some advice.
4+
5+
1. picozero is 'lightweight', it is designed to be easy to use but also needs to run on a micro controller, please take this into account when considering feature requests or raising issues.
6+
2. see below for other stuff!
7+
8+
# Status
9+
10+
picozero is currently in Beta, pre release 1.0, you should consider the following:
11+
12+
- The API is not yet set, however, this doesn't mean that backwards compatibility is not important! It is a balancing act.
13+
- Requests for new features will need to be prioritised and responses to feature requests may take some time.
14+
- Refactoring of the code base is very likely and as a result pull requests may need rework.
15+
- Issues are likely to exist within the code base, be kind!
16+
17+
# Suggestions
18+
19+
If you have an idea for a new feature or would like to see a device included in picozero, please raise an [issue](https://github.com/RaspberryPiFoundation/picozero/issues). Please explain your reasoning clearly.
20+
21+
# Bugs
22+
23+
Please raise an [issue](https://github.com/RaspberryPiFoundation/picozero/issues) for any bugs found. Please include code examples and circuit diagrams if appropriate.
24+
25+
# Pull requests
26+
27+
All pull requests should be based on the [dev](https://github.com/RaspberryPiFoundation/picozero/tree/dev) branch of picozero.
28+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behaviour:
15+
1. Setup this device like this '...'
16+
2. Run this code '....'
17+
3. This thing occurred '...'
18+
4. This error was reported '...'
19+
20+
Please include code in code blocks e.g.
21+
22+
```python
23+
print("picozero")
24+
```
25+
26+
**Expected behaviour**
27+
A clear and concise description of what you expected to happen.
28+
29+
**System information:**
30+
- OS: [e.g. Windows]
31+
- Development environment [e.g. Thonny]
32+
- picozero version: [available in `/Lib/picozero/__init__.py`]
33+
34+
**Additional context**
35+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this picozero
4+
title: ''
5+
labels: nice to have
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)