Skip to content

Commit 0f8f9cb

Browse files
dipankardipankar
committed
Working grammar!
1 parent 7eec708 commit 0f8f9cb

38 files changed

Lines changed: 9931 additions & 445 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out this form as completely as possible.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe what happened...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Create file with content '...'
27+
2. Run command '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What you expected to happen
37+
placeholder: Describe what should have happened...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: stxscript-code
43+
attributes:
44+
label: StxScript Code
45+
description: The StxScript code that causes the issue
46+
render: typescript
47+
placeholder: |
48+
let example: uint = 42u;
49+
// Add your problematic code here
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: error-output
55+
attributes:
56+
label: Error Output
57+
description: The complete error message or unexpected output
58+
render: shell
59+
placeholder: |
60+
Error transpiling file.stx: ...
61+
validations:
62+
required: false
63+
64+
- type: dropdown
65+
id: component
66+
attributes:
67+
label: Component
68+
description: Which part of StxScript is affected?
69+
options:
70+
- CLI
71+
- Python API
72+
- Grammar/Parser
73+
- Transpiler/Code Generation
74+
- Type System
75+
- Documentation
76+
- Other
77+
validations:
78+
required: true
79+
80+
- type: input
81+
id: version
82+
attributes:
83+
label: StxScript Version
84+
description: What version of StxScript are you using?
85+
placeholder: "0.1.0"
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: python-version
91+
attributes:
92+
label: Python Version
93+
description: What version of Python are you using?
94+
placeholder: "3.9.0"
95+
validations:
96+
required: true
97+
98+
- type: input
99+
id: os
100+
attributes:
101+
label: Operating System
102+
description: What operating system are you using?
103+
placeholder: "Ubuntu 20.04, macOS 12.0, Windows 11"
104+
validations:
105+
required: true
106+
107+
- type: textarea
108+
id: additional-context
109+
attributes:
110+
label: Additional Context
111+
description: Add any other context about the problem here
112+
placeholder: Any additional information that might be helpful...
113+
validations:
114+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://github.com/cryptuon/stxscript/tree/main/docs
5+
about: Check our comprehensive documentation for guides and examples
6+
- name: 🗺️ Development Roadmap
7+
url: https://github.com/cryptuon/stxscript/blob/main/docs/roadmap.md
8+
about: See our planned features and development timeline
9+
- name: 💬 GitHub Discussions
10+
url: https://github.com/cryptuon/stxscript/discussions
11+
about: Ask questions, share ideas, and discuss StxScript with the community
12+
- name: 🤝 Contributing Guide
13+
url: https://github.com/cryptuon/stxscript/blob/main/docs/contributing.md
14+
about: Learn how to contribute to StxScript development

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please check our [roadmap](https://github.com/cryptuon/stxscript/blob/main/docs/roadmap.md) first to see if it's already planned.
10+
11+
- type: dropdown
12+
id: roadmap-phase
13+
attributes:
14+
label: Roadmap Phase
15+
description: Which phase of our roadmap does this feature align with?
16+
options:
17+
- "Phase 1: Expression System (v0.2.0)"
18+
- "Phase 2: Control Flow (v0.3.0)"
19+
- "Phase 3: Data Structures (v0.4.0)"
20+
- "Phase 4: Advanced Features (v0.5.0)"
21+
- "Phase 5: Developer Experience (v1.0.0)"
22+
- "Future/Not in roadmap"
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Problem Statement
30+
description: What problem would this feature solve?
31+
placeholder: "I'm trying to do X but currently I have to..."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Proposed Solution
39+
description: Describe the feature you'd like to see
40+
placeholder: "I would like to be able to..."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: syntax-example
46+
attributes:
47+
label: Proposed Syntax
48+
description: How would this feature look in StxScript code?
49+
render: typescript
50+
placeholder: |
51+
// Example of how the feature would be used
52+
let example = new_feature_syntax();
53+
validations:
54+
required: false
55+
56+
- type: textarea
57+
id: clarity-output
58+
attributes:
59+
label: Expected Clarity Output
60+
description: What Clarity code should this generate?
61+
render: lisp
62+
placeholder: |
63+
;; Expected Clarity output
64+
(define-data-var example ...)
65+
validations:
66+
required: false
67+
68+
- type: dropdown
69+
id: priority
70+
attributes:
71+
label: Priority
72+
description: How important is this feature to you?
73+
options:
74+
- "Critical - Blocking my project"
75+
- "High - Would significantly improve my workflow"
76+
- "Medium - Would be nice to have"
77+
- "Low - Minor convenience"
78+
validations:
79+
required: true
80+
81+
- type: dropdown
82+
id: complexity
83+
attributes:
84+
label: Estimated Complexity
85+
description: How complex do you think this feature would be to implement?
86+
options:
87+
- "Low - Simple grammar/transformer change"
88+
- "Medium - Requires moderate changes"
89+
- "High - Significant design work needed"
90+
- "Unknown - Not sure"
91+
validations:
92+
required: false
93+
94+
- type: textarea
95+
id: alternatives
96+
attributes:
97+
label: Alternatives Considered
98+
description: What alternatives have you considered?
99+
placeholder: "I could work around this by..."
100+
validations:
101+
required: false
102+
103+
- type: checkboxes
104+
id: contribution
105+
attributes:
106+
label: Contribution
107+
description: Would you be interested in contributing to this feature?
108+
options:
109+
- label: I would like to implement this feature myself
110+
- label: I can help with testing this feature
111+
- label: I can help with documentation for this feature
112+
- label: I can provide additional use cases and examples
113+
114+
- type: textarea
115+
id: additional-context
116+
attributes:
117+
label: Additional Context
118+
description: Add any other context or screenshots about the feature request
119+
placeholder: Any additional information that might be helpful...
120+
validations:
121+
required: false

‎.github/ISSUE_TEMPLATE/roadmap_item.yml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
name: Roadmap Item Implementation
2+
description: Track implementation of a specific roadmap item
3+
title: "[Roadmap]: "
4+
labels: ["roadmap", "enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This template is for tracking implementation of specific items from our [development roadmap](https://github.com/cryptuon/stxscript/blob/main/docs/roadmap.md).
10+
11+
- type: dropdown
12+
id: phase
13+
attributes:
14+
label: Roadmap Phase
15+
description: Which phase is this item from?
16+
options:
17+
- "Phase 1: Expression System (v0.2.0)"
18+
- "Phase 2: Control Flow (v0.3.0)"
19+
- "Phase 3: Data Structures (v0.4.0)"
20+
- "Phase 4: Advanced Features (v0.5.0)"
21+
- "Phase 5: Developer Experience (v1.0.0)"
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: roadmap-item
27+
attributes:
28+
label: Roadmap Item
29+
description: What specific item from the roadmap is this?
30+
placeholder: "Arithmetic expressions, If/else statements, Map operations, etc."
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: description
36+
attributes:
37+
label: Implementation Description
38+
description: Detailed description of what needs to be implemented
39+
placeholder: "This involves implementing..."
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: technical-tasks
45+
attributes:
46+
label: Technical Tasks
47+
description: Break down the implementation into specific technical tasks
48+
placeholder: |
49+
- [ ] Add grammar rules for X
50+
- [ ] Implement transformer methods for Y
51+
- [ ] Add test cases for Z
52+
- [ ] Update documentation
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: examples
58+
attributes:
59+
label: Example Code
60+
description: Examples of what should work after implementation
61+
render: typescript
62+
placeholder: |
63+
// Examples of syntax that should work
64+
let result = a + b * c;
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: clarity-output
70+
attributes:
71+
label: Expected Clarity Output
72+
description: What Clarity code should be generated
73+
render: lisp
74+
placeholder: |
75+
;; Expected Clarity output
76+
(define-data-var result uint (+ a (* b c)))
77+
validations:
78+
required: false
79+
80+
- type: textarea
81+
id: dependencies
82+
attributes:
83+
label: Dependencies
84+
description: What other roadmap items or features does this depend on?
85+
placeholder: "This requires X to be implemented first..."
86+
validations:
87+
required: false
88+
89+
- type: textarea
90+
id: success-criteria
91+
attributes:
92+
label: Success Criteria
93+
description: How will we know this is complete and working correctly?
94+
placeholder: |
95+
- [ ] All listed technical tasks are complete
96+
- [ ] Test coverage is >90%
97+
- [ ] Examples in documentation work
98+
- [ ] Generated Clarity is valid
99+
validations:
100+
required: true
101+
102+
- type: dropdown
103+
id: estimated-effort
104+
attributes:
105+
label: Estimated Effort
106+
description: How much effort do you estimate this will take?
107+
options:
108+
- "Small (1-3 days)"
109+
- "Medium (1-2 weeks)"
110+
- "Large (3-4 weeks)"
111+
- "Extra Large (1+ months)"
112+
validations:
113+
required: false
114+
115+
- type: checkboxes
116+
id: contribution-interest
117+
attributes:
118+
label: Contribution Interest
119+
description: Are you interested in working on this?
120+
options:
121+
- label: I would like to implement this myself
122+
- label: I can help with implementation
123+
- label: I can help with testing
124+
- label: I can help with documentation

0 commit comments

Comments
 (0)