Skip to content

Commit 5f4ffac

Browse files
MDUYNMDUYN
committed
Add templates
1 parent 20dffa4 commit 5f4ffac

2 files changed

Lines changed: 188 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/improve-documentation.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: "📖 Improve Documentation"
2+
description: "Request new or improved documentation for an indicator or feature"
3+
title: "[Docs] "
4+
labels: ["squad", "docs"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Documentation Improvement
10+
Use this template to request new or improved documentation.
11+
12+
- type: input
13+
id: indicator-name
14+
attributes:
15+
label: Indicator / Feature Name
16+
description: "Which indicator or feature needs documentation work?"
17+
placeholder: "e.g., SuperTrend, RSI, installation guide"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: docs-type
23+
attributes:
24+
label: What needs to happen?
25+
options:
26+
- Add missing documentation page (indicator has no docs)
27+
- Improve existing documentation (unclear, incomplete, outdated)
28+
- Add usage examples or code snippets
29+
- Fix incorrect documentation
30+
- Add API reference details (parameters, return values)
31+
- Add to sidebar / navigation
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: current-page
37+
attributes:
38+
label: Current Docs Page (if exists)
39+
description: "Path to the existing docs page, or leave blank if none exists"
40+
placeholder: "e.g., docs/content/indicators/trend/supertrend.md"
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: whats-wrong
46+
attributes:
47+
label: What's Missing or Wrong?
48+
description: |
49+
Describe what's missing, unclear, or incorrect in the current documentation.
50+
placeholder: |
51+
- The parameter table is missing the `atr_multiplier` parameter
52+
- No example showing how to use with polars DataFrames
53+
- The return columns section doesn't list all output columns
54+
- ...
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: expected-content
60+
attributes:
61+
label: Expected Content
62+
description: "What should the documentation include? Be specific."
63+
placeholder: |
64+
- Full parameter table with types and defaults
65+
- Working code example using pandas
66+
- Description of all output columns
67+
- Warmup window information
68+
- Chart showing the indicator in action
69+
validations:
70+
required: false
71+
72+
- type: checkboxes
73+
id: deliverables
74+
attributes:
75+
label: Deliverables
76+
description: "What needs to be delivered?"
77+
options:
78+
- label: "New or updated Docusaurus documentation page"
79+
- label: "Add indicator to sidebar navigation"
80+
- label: "Add or update README section"
81+
- label: "Add chart image to docs page"
82+
- label: "Add code examples"
83+
84+
- type: textarea
85+
id: additional-context
86+
attributes:
87+
label: Additional Context
88+
description: "Anything else? Links to reference material, related indicators, etc."
89+
placeholder: "Optional additional context..."
90+
validations:
91+
required: false

‎.github/ISSUE_TEMPLATE/improve-tests.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: "🧪 Improve Tests"
2+
description: "Request new or improved test coverage for an indicator or feature"
3+
title: "[Tests] "
4+
labels: ["squad", "testing"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Test Improvement
10+
Use this template to request new or improved test coverage.
11+
12+
- type: input
13+
id: indicator-name
14+
attributes:
15+
label: Indicator / Feature Name
16+
description: "Which indicator or feature needs test work?"
17+
placeholder: "e.g., SuperTrend, liquidity_sweeps, date_range"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: test-type
23+
attributes:
24+
label: What needs to happen?
25+
options:
26+
- Add missing test file (indicator has no tests at all)
27+
- Add edge case tests (empty data, single row, NaN handling)
28+
- Add signal function tests
29+
- Add stats function tests
30+
- Add polars DataFrame tests
31+
- Fix flaky or broken tests
32+
- Improve test assertions (too weak / not checking output values)
33+
validations:
34+
required: true
35+
36+
- type: input
37+
id: current-test-file
38+
attributes:
39+
label: Current Test File (if exists)
40+
description: "Path to the existing test file, or leave blank if none exists"
41+
placeholder: "e.g., tests/indicators/test_supertrend.py"
42+
validations:
43+
required: false
44+
45+
- type: textarea
46+
id: whats-missing
47+
attributes:
48+
label: What's Missing or Broken?
49+
description: |
50+
Describe what tests are missing or what's wrong with existing tests.
51+
placeholder: |
52+
- No test file exists for this indicator
53+
- Missing tests for the signal function
54+
- No edge case tests for empty DataFrame input
55+
- Tests don't verify output column values, only that columns exist
56+
- ...
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: test-scenarios
62+
attributes:
63+
label: Specific Test Scenarios
64+
description: "List specific scenarios that should be tested."
65+
placeholder: |
66+
- Test with default parameters on BTC/EUR 4h data
67+
- Test with custom parameters (e.g., period=50)
68+
- Test empty DataFrame raises appropriate error
69+
- Test single-row DataFrame
70+
- Test with NaN values in input
71+
- Test polars DataFrame input returns polars DataFrame
72+
- Test output column names are correct
73+
- Test signal values are only -1, 0, or 1
74+
validations:
75+
required: false
76+
77+
- type: checkboxes
78+
id: deliverables
79+
attributes:
80+
label: Deliverables
81+
description: "What needs to be delivered?"
82+
options:
83+
- label: "New test file following project unittest pattern"
84+
- label: "Edge case tests (empty, NaN, single row)"
85+
- label: "Signal function tests"
86+
- label: "Stats function tests"
87+
- label: "Polars DataFrame compatibility tests"
88+
- label: "All tests passing locally"
89+
90+
- type: textarea
91+
id: additional-context
92+
attributes:
93+
label: Additional Context
94+
description: "Anything else? Known bugs, related indicators, reference implementations."
95+
placeholder: "Optional additional context..."
96+
validations:
97+
required: false

0 commit comments

Comments
 (0)