Skip to content

Commit 8fadb01

Browse files
Added PR/Issue templates
1 parent 9301620 commit 8fadb01

File tree

8 files changed

+143
-1
lines changed

8 files changed

+143
-1
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Report a bug
2+
description: Tell us about a bug or issue you may have identified in ESP32_FlashMate.
3+
title: "Provide a general summary of the issue"
4+
assignees: "DefinetlyNotAI"
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Prerequisites
9+
description: Take a couple minutes to help our maintainers work faster.
10+
options:
11+
- label: I have [searched](https://github.com/DefinetlyNotAI/ESP32_FlashMate/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues.
12+
required: true
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: Describe the issue
17+
description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: extra
22+
attributes:
23+
label: Anything else?
24+
description: Include anything you deem important. For example, the terminal output when the error occured!
25+
validations:
26+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Community Support
4+
url: https://github.com/orgs/community/discussions
5+
about: Please ask and answer questions here.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Report a development bug
2+
description: Tell us about a bug or issue you may have identified while developing ESP32_FlashMate.
3+
title: "Provide a general summary of the development issue"
4+
assignees: "DefinetlyNotAI"
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Prerequisites
9+
description: Take a couple minutes to help our maintainers work faster.
10+
options:
11+
- label: I have [searched](https://github.com/DefinetlyNotAI/ESP32_FlashMate/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues.
12+
required: true
13+
- label: I have made sure the issue is not a user error, and have made sure no external modification are responsible for this bug.
14+
required: true
15+
- type: textarea
16+
id: what-happened
17+
attributes:
18+
label: Describe the issue
19+
description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: extra
24+
attributes:
25+
label: Anything else?
26+
description: Include anything you deem important, like the terminal output!
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: for_where
31+
attributes:
32+
label: What part of the project does this affect?
33+
description: eg. The core logic or flashing aspect?
34+
validations:
35+
required: true
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature request
2+
description: Suggest new or updated features to include in ESP32_FlashMate.
3+
title: "Suggest a new feature"
4+
assignees: "DefinetlyNotAI"
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Prerequisites
9+
description: Take a couple minutes to help our maintainers work faster.
10+
options:
11+
- label: I have [searched](https://github.com/DefinetlyNotAI/ESP32_FlashMate/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed feature requests
12+
required: true
13+
- label: I would like to contribute this request (Optional).
14+
required: false
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Proposal
19+
description: Provide detailed information for what we should add, including relevant links to prior art, screenshots, or live demos whenever possible.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: motivation
24+
attributes:
25+
label: Motivation and context
26+
description: Tell us why this change is needed or helpful, and what problems it may help solve.
27+
validations:
28+
required: true
29+
- type: dropdown
30+
id: importance
31+
attributes:
32+
label: What is the importance for implementing this idea?
33+
multiple: false
34+
options:
35+
- High
36+
- Normal
37+
- Low
38+
- N/A
39+
validations:
40+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Pull Request Template
2+
3+
### Prerequisites
4+
5+
<!-- Take a couple of minutes to help our maintainers work faster by checking of the pre-requisites. -->
6+
<!-- To tick the checkboxes replace the space with an 'x', so [ ] becomes [x] . -->
7+
8+
- [ ] I have [searched](https://github.com/DefinetlyNotAI/ESP32_FlashMate/pulls) for duplicate or closed issues.
9+
- [ ] I have updated the documentation accordingly, if required.
10+
- [ ] I have tested my code, if required.
11+
12+
### PR Type
13+
14+
<!-- Take a couple of minutes to help our maintainers work faster by telling us what is the PR guided on. -->
15+
<!-- To tick the checkboxes replace the space with an 'x', so [ ] becomes [x] . -->
16+
17+
- [ ] Bug fix <!-- Non-Breaking Bug Fix - Usually relates to fixing an issue -->
18+
- [ ] Deprecation Change <!-- Removing a deprecation -->
19+
- [ ] New feature <!-- Non-Breaking Change that adds a new feature -->
20+
- [ ] Refactoring <!-- Non-Breaking Change that modifies existing code to refactor it to become more organised -->
21+
- [ ] Documentation
22+
update <!-- Non-Breaking Change that modifies existing documentation to refactor it or add extra comments - either wiki, md files or code is included here -->
23+
- [ ] ⚠️ Breaking change ⚠️ <!-- Breaking Bug Fix / New Addition that changes how Logicytics works -->
24+
25+
### Description
26+
27+
<!-- REQUIRED: Provide a summary of the PR and what you expected to happen. -->
28+
29+
### Credit
30+
31+
<!-- If this PR is a contribution, please mention the contributors here using the appropriate syntax. Refrence their username, with a link -->
32+
33+
### Issues Fixed
34+
35+
<!-- REQUIRED: What issues will be fixed? (Format: "#50, #23" etc.) if none exist type _N/A_ -->

.idea/.name

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
File renamed without changes.

.idea/modules.xml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)