-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue: #1; API-modification: Y[]/N[X]; Initial Commit of the ReleaseFab open-source project.
- Loading branch information
0 parents
commit 05c0f3c
Showing
211 changed files
with
27,708 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
name: Bug | ||
description: File a bug/issue | ||
title: "[BUG] <title>" | ||
labels: [bug] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the [existing issues](https://github.com/comlet/releasefab/issues?q=label%3Abug) | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current Behavior | ||
description: A concise description of what you're experiencing. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected Behavior | ||
description: A concise description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Steps To Reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
1. In this environment... | ||
2. With this config... | ||
3. Run '...' | ||
4. See error... | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Feature Request | ||
description: File a feature request or propose an enhancement | ||
title: "[ENHANCEMENT] <title>" | ||
labels: [enhancement] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: What should this feature achieve? | ||
description: A concise description of the goal your feature is helping to achieve | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: How do you want to achieve said goal | ||
description: A description of your implementation idea | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Why is this feature necessary? | ||
description: Name a few reasons to implement your feature | ||
placeholder: | | ||
1. It increases the level of automation... | ||
2. Contributes to the clean code rule... | ||
3. Improves the user experience... | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: Question | ||
description: Ask a question regarding all aspects of this project (Development, Usage, Documentation etc.) | ||
title: "[QUESTION] <title>" | ||
labels: [question] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: What is your question? | ||
description: A well thought out question | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Further information | ||
description: More information if necessary (e.g. Configuration files, intentions etc.) | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Description | ||
|
||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
|
||
Fixes # (issue) | ||
|
||
## Type of change | ||
|
||
Please delete options that are not relevant. | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
# How Has This Been Tested? | ||
|
||
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 | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
|
||
**Test Configuration**: | ||
* Firmware version: | ||
* Hardware: | ||
* Toolchain: | ||
* SDK: | ||
|
||
# Checklist: | ||
|
||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
- [ ] Any dependent changes have been merged and published in downstream modules |
105 changes: 105 additions & 0 deletions
105
.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
name: Pull Request | ||
description: Create a pull request | ||
title: [PR] <title> | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Issue ID | ||
description: Please provide the ID of the Issue associated with this PR | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Type of change | ||
description: Please delete options that are not relevant. | ||
placeholder: | | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: How Has This Been Tested? | ||
description: 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. | ||
placeholder: | | ||
- [ ] Test A | ||
- [ ] Test B | ||
validations: | ||
required: false | ||
|
||
# Checklist: | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Coding Style Guidelines | ||
description: Does your code follow the projects coding styles? | ||
options: | ||
- label: My code follows the style guidelines of this project | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Self-Review | ||
description: Did you review your own code? | ||
options: | ||
- label: I have performed a self-review of my own code | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Comments | ||
description: Did you comment the code you added? | ||
options: | ||
- label: I have commented my code, particularly in hard-to-understand areas | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Documentation | ||
description: Did you update the documentation? | ||
options: | ||
- label: I have made corresponding changes to the documentation | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Warnings | ||
description: Does your code generate new warnings? | ||
options: | ||
- label: My changes generate no new warnings | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: New Tests | ||
description: Did you write tests for your code? | ||
options: | ||
- label: I have added tests that prove my fix is effective or that my feature works | ||
required: false | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Existing Tests | ||
description: Do the existing tests still pass? | ||
options: | ||
- label: New and existing unit tests pass locally with my changes | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Dependent Changes | ||
description: Did you merge all dependent changes, if any? | ||
options: | ||
- label: Any dependent changes have been merged and published in downstream modules | ||
required: true |
Oops, something went wrong.