|
| 1 | +structure: |
| 2 | + - .github/PULL_REQUEST_TEMPLATE/bug_fix_template.md: |
| 3 | + content: | |
| 4 | + ## Bug Fix |
| 5 | + ### Description |
| 6 | + <!--- A clear and concise description of what the bug is. --> |
| 7 | + ### Steps to Reproduce |
| 8 | + <!--- Steps to reproduce the behavior: --> |
| 9 | + 1. Go to '...' |
| 10 | + 2. Click on '....' |
| 11 | + 3. Scroll down to '....' |
| 12 | + 4. See error |
| 13 | + ### Expected Behavior |
| 14 | + <!--- A clear and concise description of what you expected to happen. --> |
| 15 | + ### Screenshots |
| 16 | + <!--- If applicable, add screenshots to help explain your problem. --> |
| 17 | + ### Additional context |
| 18 | + <!--- Add any other context about the problem here. --> |
| 19 | + - .github/PULL_REQUEST_TEMPLATE/feature_request_template.md: |
| 20 | + content: | |
| 21 | + ## Feature Request |
| 22 | + ### Description |
| 23 | + <!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [.. |
| 24 | + ### Solution |
| 25 | + <!--- A clear and concise description of what you want to happen. --> |
| 26 | + ### Alternatives |
| 27 | + <!--- A clear and concise description of any alternative solutions or features you've considered. --> |
| 28 | + ### Screenshots |
| 29 | + <!--- If applicable, add screenshots to help explain your problem. --> |
| 30 | + ### Additional context |
| 31 | + <!--- Add any other context or screenshots about the feature request here. --> |
| 32 | + - .github/PULL_REQUEST_TEMPLATE/pull_request_template.md: |
| 33 | + content: | |
| 34 | + # Description |
| 35 | +
|
| 36 | + Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. |
| 37 | +
|
| 38 | + Fixes # (issue) |
| 39 | +
|
| 40 | + ## Type of change |
| 41 | +
|
| 42 | + Please delete options that are not relevant. |
| 43 | +
|
| 44 | + - [ ] Bug fix (non-breaking change which fixes an issue) |
| 45 | + - [ ] New feature (non-breaking change which adds functionality) |
| 46 | + - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 47 | + - [ ] This change requires a documentation update |
| 48 | +
|
| 49 | + # How Has This Been Tested? |
| 50 | +
|
| 51 | + Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration |
| 52 | +
|
| 53 | + - [ ] Test A |
| 54 | + - [ ] Test B |
| 55 | +
|
| 56 | + **Test Configuration**: |
| 57 | + * Firmware version: |
| 58 | + * Hardware: |
| 59 | + * Toolchain: |
| 60 | + * SDK: |
| 61 | +
|
| 62 | + # Checklist: |
| 63 | +
|
| 64 | + - [ ] My code follows the style guidelines of this project |
| 65 | + - [ ] I have performed a self-review of my code |
| 66 | + - [ ] I have commented my code, particularly in hard-to-understand areas |
| 67 | + - [ ] I have made corresponding changes to the documentation |
| 68 | + - [ ] My changes generate no new warnings |
| 69 | + - [ ] I have added tests that prove my fix is effective or that my feature works |
| 70 | + - [ ] New and existing unit tests pass locally with my changes |
| 71 | + - [ ] Any dependent changes have been merged and published in downstream modules |
| 72 | + - .github/ISSUE_TEMPLATE/issue_template.md: |
| 73 | + content: | |
| 74 | + ## I'm submitting a ... |
| 75 | +
|
| 76 | + - [ ] bug report |
| 77 | + - [ ] feature request |
| 78 | +
|
| 79 | + ## What is the current behavior? |
| 80 | +
|
| 81 | + ## If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem |
| 82 | +
|
| 83 | + ## What is the expected behavior? |
| 84 | +
|
| 85 | + ## What is the motivation / use case for changing the behavior? |
| 86 | +
|
| 87 | + ## Please tell us about your environment: |
| 88 | +
|
| 89 | + Version: 2.0.0-beta.X |
| 90 | + Browser: |
| 91 | + Language: |
0 commit comments