Skip to content

Commit 835fb3a

Browse files
committed
Add issue reporting guidance and templates
1 parent 084b0df commit 835fb3a

5 files changed

Lines changed: 101 additions & 0 deletions

File tree

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Bug report
2+
description: Report a validator bug, false positive, missing Pine Script v6 behavior, or confusing diagnostic.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: Briefly describe the problem.
12+
placeholder: The validator reports a false warning for...
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: pine_snippet
18+
attributes:
19+
label: Pine snippet
20+
description: Paste the smallest Pine Script example that reproduces the issue.
21+
render: pine
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: command
27+
attributes:
28+
label: Command used
29+
description: Paste the exact command you ran.
30+
placeholder: python -m pinescript_validator.cli example.pine --agent-json
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: actual
36+
attributes:
37+
label: Actual output
38+
description: Paste the validator output you received.
39+
render: text
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: expected
45+
attributes:
46+
label: Expected behavior
47+
description: Describe what you expected instead.
48+
validations:
49+
required: true
50+
51+
- type: input
52+
id: environment
53+
attributes:
54+
label: Environment
55+
description: Python version, OS, and any other useful environment details.
56+
placeholder: Python 3.13 on Windows 11

.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: Questions and general discussion
4+
url: https://github.com/Poryaei/pine-script-validator/issues
5+
about: Use GitHub Issues if you are unsure whether something is a bug, feature request, or Pine Script v6 compatibility gap.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Suggest a new validator capability, Pine Script v6 support improvement, or agent workflow enhancement.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem or workflow gap
11+
description: What is missing or difficult today?
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Proposed improvement
19+
description: Describe the feature, CLI behavior, or validation capability you would like to see.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: context
25+
attributes:
26+
label: Additional context
27+
description: Include Pine examples, agent workflows, CI use cases, or anything else that helps.

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Thanks for contributing to `pine-script-validator`.
44

5+
If you find a bug, false positive, missing Pine Script v6 feature, or an unclear diagnostic, please open an issue in the [GitHub Issues](https://github.com/Poryaei/pine-script-validator/issues) section first when possible.
6+
57
## Development Setup
68

79
```powershell

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,17 @@ pyproject.toml Packaging and pytest configuration
197197

198198
Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)
199199

200+
## Feedback And Issues
201+
202+
If you spot a bug, false positive, missing Pine Script v6 behavior, or a confusing diagnostic, please open an issue in the [GitHub Issues](https://github.com/Poryaei/pine-script-validator/issues) section.
203+
204+
Helpful issue reports usually include:
205+
206+
- the Pine snippet or file shape that triggered the problem
207+
- the exact command you ran
208+
- the validator output you received
209+
- the behavior you expected instead
210+
200211
## Scope And Limitations
201212

202213
- This is a validator and static analysis tool, not a Pine runtime

0 commit comments

Comments
 (0)