diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9ca1398 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Signal a problem with a device driver. +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Run program +```go +package main + +import ( + "periph.io/x/host/v3" +) + +func main() { + host.Init() +} +``` +2. Run it. +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Platform (please complete the following information):** + - OS: [e.g. Raspbian Buster Lite] + - Board [e.g. Raspberry Pi 4] + - Device [e.g. cap1114] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2f9aec8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: What would you like to see supported? +--- + +**What kind of new feature are you looking for?** +(Keep the one that applies, please describe) +- Hardware: [new device kind] +- Software: [new OS support, new integration, new logic package, etc] + +**Do you plan to:** +- Contribute an initial driver: [Yes/No] +- Write unit tests: [Yes/No] +- Update https://github.com/periph/cmd to use the new functionality: [Yes/No] diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9824011 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +1. Please prefix the issue title with the primary package affected. For example, +if this PR fixes periph.io/x/devices/v3/cap1xxx, prefix the PR title with "cap1xxx:". + +2. Mention the issue number it fixes or add the details of the changes if it +doesn't have a specific issue. Examples: +- Fixes #12345 +- Helps with #12345 but doesn't not completely fix it. + +3. Once integrated, send a PR to https://github.com/periph/cmd to leverage the +new functionality (if relevant).