Skip to content

Commit c923bbf

Browse files
DefinetlyNotAIDefinetlyNotAI
committed
Added issue templates, updated the TODO
1 parent 2046c8e commit c923bbf

File tree

5 files changed

+144
-4
lines changed

5 files changed

+144
-4
lines changed

‎.github/ISSUE_TEMPLATES/bug_report.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Report a bug
2+
description: Tell us about a bug or issue you may have identified in PyCTools.
3+
title: "Provide a general summary of the issue"
4+
labels: [ "waiting for review" ]
5+
assignees: "DefinetlyNotAI"
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Prerequisites
10+
description: Take a couple minutes to help our maintainers work faster.
11+
options:
12+
- label: I have [searched](https://github.com/DefinetlyNotAI/PyCTools/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues.
13+
required: true
14+
- label: I have read the [contributing guidelines](https://github.com/DefinetlyNotAI/PyCTools/blob/main/CONTRIBUTING.md).
15+
required: true
16+
- label: I have checked that I am on the latest release, and have made sure no external modification are responsible for this bug.
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: Describe the issue
22+
description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: d_log
27+
attributes:
28+
label: Console Output
29+
description: Paste in here exactly what you see in the console when you run the script.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: extra
34+
attributes:
35+
label: Anything else?
36+
description: Include anything you deem important.
37+
validations:
38+
required: false
39+
- type: input
40+
id: version
41+
attributes:
42+
label: What version of PyCTools are you using?
43+
placeholder: "e.g., v0.1.0 or v1.4.0"
44+
validations:
45+
required: true

‎.github/ISSUE_TEMPLATES/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Logicytics Log Parser
4+
url: https://definetlynotai.github.io/Logicytics_Logs/
5+
about: To get your logs in a prettier and easier to understand format, upload your log there.
6+
- name: GitHub Community Support
7+
url: https://github.com/orgs/community/discussions
8+
about: Please ask and answer questions here.

‎.github/ISSUE_TEMPLATES/dev_bug_report.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Report a development bug
2+
description: Tell us about a bug or issue you may have identified while developing PyCTools.
3+
title: "Provide a general summary of the development issue"
4+
labels: [ "waiting for review" ]
5+
assignees: "DefinetlyNotAI"
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Prerequisites
10+
description: Take a couple minutes to help our maintainers work faster.
11+
options:
12+
- label: I have [searched](https://github.com/DefinetlyNotAI/PyCTools/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues.
13+
required: true
14+
- label: I have read the [contributing guidelines](https://github.com/DefinetlyNotAI/PyCTools/blob/main/CONTRIBUTING.md).
15+
required: true
16+
- label: I have made sure the issue is not a user error, and have made sure no external modification are responsible for this bug.
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: Describe the issue
22+
description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: d_log
27+
attributes:
28+
label: Console Output
29+
description: Paste in here exactly what you see in the console when you run the script.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: extra
34+
attributes:
35+
label: Anything else?
36+
description: Include anything you deem important.
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: for_where
41+
attributes:
42+
label: What part of the project does this affect?
43+
description: eg. The core logic, The hRNG, etc.
44+
validations:
45+
required: true

‎.github/ISSUE_TEMPLATES/feature_request.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature request
2+
description: Suggest new or updated features to include in PyCTools.
3+
title: "Suggest a new feature"
4+
labels: [ "waiting for review" ]
5+
assignees: "DefinetlyNotAI"
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Prerequisites
10+
description: Take a couple minutes to help our maintainers work faster.
11+
options:
12+
- label: I have [searched](https://github.com/DefinetlyNotAI/PyCTools/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed feature requests
13+
required: true
14+
- label: I have read the [contributing guidelines](https://github.com/PyCTools/Logicytics/blob/main/CONTRIBUTING.md)
15+
required: true
16+
- label: I would like to contribute this request (Optional).
17+
required: false
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: Proposal
22+
description: Provide detailed information for what we should add, including relevant links to prior art, screenshots, or live demos whenever possible.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: motivation
27+
attributes:
28+
label: Motivation and context
29+
description: Tell us why this change is needed or helpful, and what problems it may help solve.
30+
validations:
31+
required: true
32+
- type: dropdown
33+
id: importance
34+
attributes:
35+
label: What is the importance for implementing this idea?
36+
multiple: false
37+
options:
38+
- High
39+
- Normal
40+
- Low
41+
validations:
42+
required: true

‎TODO.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
| Item | Description | Priority | Version to Expect |
2-
|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------|
3-
| RNG Customisation | Add more customisation options to the RNG functions and streamline it fully | Medium | 0.3.0-beta |
4-
| Process Inspect OnDemand | Add an ondemand feature to process inspect: monitor an app and send data at intervals to the caller (possibly async), with .end to stop, and support for flags. Useful for sysadmin panels. | High | 0.3.0-beta |
1+
| Item | Description | Priority | Version to Expect |
2+
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------|
3+
| hRNG | Add more customisation options to the RNG functions and streamline it fully | Medium | 0.3.0-beta |
4+
| processInspect | Add an ondemand feature to process inspect: monitor an app and send data at intervals to the caller (possibly async), with .end to stop, and support for flags. Useful for sysadmin panels. | High | 0.3.0-beta |

0 commit comments

Comments
 (0)