Skip to content

Commit db6124b

Browse files
chore: align issue templates across repositories (#267) (#268)
1 parent ed53c7f commit db6124b

4 files changed

Lines changed: 55 additions & 25 deletions

File tree

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,38 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve OpenAEV
3+
about: Create a bug report to help us improve the OpenAEV Python client
44
title: 'fix: '
5-
labels: bug, needs triage
5+
labels: needs triage, bug
66
assignees: ''
7+
type: bug
78

89
---
910

10-
Please replace every line in curly brackets { like this } with an appropriate answer, and remove this line.
11-
1211
## Description
1312

14-
{ Please provide a clear and concise description of the bug. }
13+
<!-- Please provide a clear and concise description of the bug. -->
1514

1615
## Environment
1716

18-
1. OS (where OpenCTI server runs): { e.g. Mac OS 10, Windows 10, Ubuntu 16.4, etc. }
19-
2. OpenCTI version: { e.g. OpenCTI 1.0.2 }
17+
1. OS: { e.g. macOS 14, Windows 11, Ubuntu 22.04, etc. }
18+
2. Version: { e.g. 1.2.3 }
2019
3. Other environment details:
2120

22-
## Reproducible Steps
21+
## Reproducible steps
2322

2423
Steps to create the smallest reproducible scenario:
2524
1. { e.g. Run ... }
2625
2. { e.g. Click ... }
2726
3. { e.g. Error ... }
2827

29-
## Expected Output
28+
## Expected output
3029

31-
{ Please describe what you expected to happen. }
30+
<!-- Please describe what you expected to happen. -->
3231

33-
## Actual Output
32+
## Actual output
3433

35-
{ Please describe what actually happened. }
34+
<!-- Please describe what actually happened. -->
3635

3736
## Additional information
3837

39-
{ Any additional information, including logs or screenshots if you have any. }
38+
<!-- Any additional information, including logs or screenshots if you have any. -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Documentation request
2+
description: Request new or improved documentation for the OpenAEV Python client.
3+
title: "docs: "
4+
labels:
5+
- needs triage
6+
- documentation
7+
body:
8+
- type: textarea
9+
id: request-details
10+
attributes:
11+
label: Documentation request
12+
description: "Please explain what you want to document or clarify."
13+
placeholder: "Describe the missing documentation, unclear section, or new topic you would like to see covered."
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: additional-context
18+
attributes:
19+
label: Additional context
20+
description: "Any links, screenshots or references that help."
21+
validations:
22+
required: false
Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
---
22
name: Feature request
3-
about: Ask for a new feature to be implemented in OpenAEV
3+
about: Suggest a new feature or capability for the OpenAEV Python client
44
title: 'feat: '
5-
labels: feature, needs triage
5+
labels: needs triage, feature
66
assignees: ''
7+
type: feature
78

89
---
910

10-
Please replace every line in curly brackets { like this } with appropriate answers, and remove this line.
11+
## Use case
1112

12-
## Problem to Solve
13+
<!-- Please describe the use case for which you need a solution. -->
1314

14-
{ Please describe the problem you would like to solve. }
15+
## Current workaround
1516

16-
## Current Workaround
17+
<!-- Please describe how you currently solve or work around this problem. -->
1718

18-
{ Please describe how you currently solve or work around this problem, given OpenAEV's limitation. }
19+
## Proposed solution
1920

20-
## Proposed Solution
21+
<!-- Please describe the solution you would like to be provided. -->
2122

22-
{ Please describe the solution you would like OpenAEV to provide, to solve the problem above. }
23+
## Additional information
2324

24-
## Additional Information
25+
<!-- Any additional information, including logs or screenshots if you have any. -->
2526

26-
{ Any additional information, including logs or screenshots if you have any. }
27+
## If the feature request is approved, would you be willing to submit a PR?
28+
29+
Yes / No (help can be provided if you need assistance submitting a PR)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Question
3-
about: Ask a question about the project
3+
about: Ask a question about the OpenAEV Python client
44
title: ''
55
labels: needs triage, question
66
assignees: ''
@@ -17,6 +17,12 @@ assignees: ''
1717

1818
<!-- Please provide a clear and concise description of your question. -->
1919

20+
## Environment
21+
22+
1. OS: { e.g. macOS 14, Windows 11, Ubuntu 22.04, etc. }
23+
2. Version: { e.g. 1.2.3 }
24+
3. Other environment details:
25+
2026
## Additional information
2127

2228
<!-- Any additional information, including logs or screenshots if you have any. -->

0 commit comments

Comments
 (0)