From fc07c7c01fc58b63c62e38949dbd485a39a3e374 Mon Sep 17 00:00:00 2001 From: Kevin Hester Date: Thu, 25 Jun 2020 09:18:54 -0700 Subject: [PATCH 1/2] Update issue templates --- .../bug-report-or-feature-proposal.md | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report-or-feature-proposal.md diff --git a/.github/ISSUE_TEMPLATE/bug-report-or-feature-proposal.md b/.github/ISSUE_TEMPLATE/bug-report-or-feature-proposal.md new file mode 100644 index 000000000..42f3b0d2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report-or-feature-proposal.md @@ -0,0 +1,38 @@ +--- +name: Bug report or feature proposal +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +Please - if you just have a question (i.e. not a bug report or a feature proposal), post in our [forum](https://meshtastic.discourse.group/) instead. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Device info:** + - Device model: [e.g. TBEAM] + - Software Version [e.g. 0.7.8] + +**Smartphone information (if relevant):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - App Version [e.g. 0.7.2] + +**Additional context** +Add any other context about the problem here. From 7f5283e95d7d1fb06931ada0950fa75e5eed1c18 Mon Sep 17 00:00:00 2001 From: geeksville Date: Thu, 25 Jun 2020 09:33:29 -0700 Subject: [PATCH 2/2] Add an initial pull-request template --- .github/pull_request_template.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..8b7b4592c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +## Thank you for sending in a pull request, here's some tips to get started! + +(Please delete all these tips and replace with your text) + +- Before starting on some new big chunk of code, it it is optional but highly recommended to open an issue first + to say "hey, I think this idea X should be implemented and I'm starting work on it. My general plan is Y, any feedback + is appreciated." This will allow other devs to potentially save you time by not accidentially duplicating work etc... +- Please do not check in files that don't have real changes +- Please do not reformat lines that you didn't have to change the code on +- We recommend using the [Visual Studio Code](https://platformio.org/install/ide?install=vscode) editor, + because automatically follows our indentation rules and it's auto reformatting will not cause spurious changes to lines. +- If your PR fixes a bug, mention "fixes #bugnum" somewhere in your pull request description. +- If your other co-developers have comments on your PR please tweak as needed.