Skip to content

Commit ec112e2

Browse files
committed
feat: add GitHub issue templates for new tests, test fixes, and new features
1 parent 0373008 commit ec112e2

5 files changed

Lines changed: 193 additions & 0 deletions

File tree

.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: true
2+
contact_links:
3+
- name: Documentation
4+
url: https://github.com/coding-kitties/investing-algorithm-framework#readme
5+
about: Check the documentation before opening an issue.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: "✨ New Feature"
2+
description: Propose a new feature for the investing algorithm framework.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: What problem does this feature solve? Why is it needed?
16+
placeholder: I'm frustrated when ...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the feature and how it should work.
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: area
30+
attributes:
31+
label: Framework Area
32+
description: Which part of the framework does this affect?
33+
options:
34+
- Core (app, algorithm)
35+
- Backtesting
36+
- Data providers
37+
- Order execution
38+
- Portfolio management
39+
- CLI
40+
- Analysis / Reporting
41+
- Infrastructure / Deployment
42+
- Documentation
43+
- Other
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Alternatives Considered
51+
description: Have you considered any alternative approaches?
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: Additional Context
59+
description: Any mockups, reference implementations, or related issues.
60+
validations:
61+
required: false
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "🧪 New Test"
2+
description: Propose a new test case for the framework.
3+
title: "[Test]: "
4+
labels: ["test", "enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve test coverage! Please fill out the details below.
10+
11+
- type: input
12+
id: module
13+
attributes:
14+
label: Module / Component
15+
description: Which module or component should this test cover?
16+
placeholder: e.g. app/algorithm, domain/models, services/order_service
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Test Description
24+
description: Describe what the test should verify.
25+
placeholder: Describe the behavior or scenario you want to test.
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: test-type
31+
attributes:
32+
label: Test Type
33+
options:
34+
- Unit test
35+
- Integration test
36+
- End-to-end test
37+
- Backtest scenario
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: acceptance-criteria
43+
attributes:
44+
label: Acceptance Criteria
45+
description: What conditions must be met for this test to pass?
46+
placeholder: |
47+
- Given ...
48+
- When ...
49+
- Then ...
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional Context
57+
description: Any additional information, links, or screenshots.
58+
validations:
59+
required: false
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "🔧 Test Improvement / Fix"
2+
description: Report a failing, flaky, or incomplete test that needs attention.
3+
title: "[Test Fix]: "
4+
labels: ["test", "bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Help us keep the test suite reliable. Describe the issue below.
10+
11+
- type: input
12+
id: test-file
13+
attributes:
14+
label: Test File
15+
description: Path to the affected test file.
16+
placeholder: e.g. tests/app/test_backtesting.py
17+
validations:
18+
required: true
19+
20+
- type: input
21+
id: test-name
22+
attributes:
23+
label: Test Name
24+
description: Name of the specific test function (if applicable).
25+
placeholder: e.g. test_backtest_with_limit_orders
26+
validations:
27+
required: false
28+
29+
- type: dropdown
30+
id: issue-type
31+
attributes:
32+
label: Issue Type
33+
options:
34+
- Failing test
35+
- Flaky / intermittent failure
36+
- Incorrect assertion
37+
- Missing edge case coverage
38+
- Performance issue
39+
- Test refactor needed
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: description
45+
attributes:
46+
label: Description
47+
description: Describe what's wrong and what the expected behavior should be.
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: reproduction
53+
attributes:
54+
label: Steps to Reproduce
55+
description: How can someone reproduce the issue?
56+
placeholder: |
57+
1. Run `python -m pytest tests/...`
58+
2. Observe ...
59+
validations:
60+
required: false
61+
62+
- type: textarea
63+
id: additional-context
64+
attributes:
65+
label: Additional Context
66+
description: Error output, logs, or screenshots.
67+
validations:
68+
required: false

.squad/decisions/inbox/copilot-directive-2026-03-09-no-squad-on-main.md

Whitespace-only changes.

0 commit comments

Comments
 (0)