a reactive (signals based) hypermedia web framework (wip) stormlightlabs.github.io/volt/
hypermedia frontend signals

docs: issue templates/forms

Changed files
+358
.github
+126
.github/ISSUE_TEMPLATE/bug_report.yml
··· 1 + name: Bug Report 2 + description: Report a bug or unexpected behavior in VoltX.js 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 this bug! Please provide as much detail as possible to help us reproduce and fix the issue. 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 the bug... 17 + validations: 18 + required: true 19 + 20 + - type: textarea 21 + id: reproduction 22 + attributes: 23 + label: Steps to Reproduce 24 + description: Detailed steps to reproduce the behavior 25 + placeholder: | 26 + 1. Mount a component with... 27 + 2. Click on... 28 + 3. Observe... 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 happen... 38 + validations: 39 + required: true 40 + 41 + - type: textarea 42 + id: actual 43 + attributes: 44 + label: Actual Behavior 45 + description: What actually happened 46 + placeholder: Describe what actually happens... 47 + validations: 48 + required: true 49 + 50 + - type: dropdown 51 + id: mode 52 + attributes: 53 + label: Usage Mode 54 + description: Which mode are you using? 55 + options: 56 + - Declarative (HTML attributes with charge()) 57 + - Programmatic (JavaScript with mount()) 58 + - Both 59 + - Not sure 60 + validations: 61 + required: true 62 + 63 + - type: textarea 64 + id: code 65 + attributes: 66 + label: Minimal Reproduction 67 + description: Minimal code example that reproduces the issue 68 + placeholder: | 69 + <!-- Your HTML and JavaScript here --> 70 + render: html 71 + validations: 72 + required: true 73 + 74 + - type: input 75 + id: version 76 + attributes: 77 + label: VoltX Version 78 + description: Which version of VoltX are you using? 79 + placeholder: e.g., 0.5.1 80 + validations: 81 + required: true 82 + 83 + - type: dropdown 84 + id: browser 85 + attributes: 86 + label: Browser 87 + description: Which browser(s) does this occur in? 88 + multiple: true 89 + options: 90 + - Chrome 91 + - Firefox 92 + - Safari 93 + - Edge 94 + - Other 95 + validations: 96 + required: true 97 + 98 + - type: textarea 99 + id: environment 100 + attributes: 101 + label: Environment Details 102 + description: Additional environment information (OS, Node version if relevant, etc.) 103 + placeholder: | 104 + - OS: macOS 14.0 105 + - Node: v20.0.0 106 + - Package manager: pnpm 8.0.0 107 + 108 + - type: textarea 109 + id: additional 110 + attributes: 111 + label: Additional Context 112 + description: Any other context, screenshots, or information about the problem 113 + placeholder: Add any other context here... 114 + 115 + - type: checkboxes 116 + id: confirmations 117 + attributes: 118 + label: Confirmations 119 + description: Please confirm the following 120 + options: 121 + - label: I have searched existing issues to ensure this bug hasn't been reported 122 + required: true 123 + - label: I have tested with the latest version of VoltX 124 + required: true 125 + - label: I have provided a minimal reproduction of the issue 126 + required: true
+11
.github/ISSUE_TEMPLATE/config.yml
··· 1 + blank_issues_enabled: false 2 + contact_links: 3 + - name: Question or Discussion 4 + url: https://github.com/stormlightlabs/volt/discussions 5 + about: Ask questions, share ideas, or discuss VoltX.js with the community 6 + - name: Documentation 7 + url: https://stormlightlabs.github.io/volt 8 + about: Read the official VoltX.js documentation 9 + - name: Security Vulnerability 10 + url: https://github.com/stormlightlabs/volt/security/advisories/new 11 + about: Report security vulnerabilities privately
+92
.github/ISSUE_TEMPLATE/documentation.yml
··· 1 + name: Documentation Improvement 2 + description: Report issues or suggest improvements to VoltX.js documentation 3 + title: "[Docs]: " 4 + labels: ["documentation"] 5 + body: 6 + - type: markdown 7 + attributes: 8 + value: | 9 + Thanks for helping improve VoltX documentation! Clear docs are essential for a great developer experience. 10 + 11 + - type: dropdown 12 + id: doc-type 13 + attributes: 14 + label: Documentation Type 15 + description: What type of documentation needs improvement? 16 + options: 17 + - API documentation 18 + - Guide or tutorial 19 + - Examples 20 + - README 21 + - Code comments 22 + - Error messages 23 + - Migration guide 24 + - Other 25 + validations: 26 + required: true 27 + 28 + - type: dropdown 29 + id: issue-type 30 + attributes: 31 + label: Issue Type 32 + description: What kind of issue is this? 33 + options: 34 + - Missing documentation 35 + - Incorrect or outdated information 36 + - Unclear or confusing explanation 37 + - Broken link or example 38 + - Typo or formatting issue 39 + - Missing code example 40 + - Other 41 + validations: 42 + required: true 43 + 44 + - type: input 45 + id: location 46 + attributes: 47 + label: Documentation Location 48 + description: Link or path to the documentation that needs improvement 49 + placeholder: e.g., https://voltx.dev/guide/reactivity or docs/guide/reactivity.md 50 + validations: 51 + required: true 52 + 53 + - type: textarea 54 + id: problem 55 + attributes: 56 + label: What's Wrong or Missing? 57 + description: Describe the current state of the documentation and what's problematic 58 + placeholder: | 59 + Current state: The documentation says... 60 + Problem: This is confusing because... 61 + validations: 62 + required: true 63 + 64 + - type: textarea 65 + id: suggestion 66 + attributes: 67 + label: Suggested Improvement 68 + description: How would you improve this documentation? 69 + placeholder: | 70 + Proposed change: Add an example showing... 71 + Or: Clarify that... 72 + 73 + - type: textarea 74 + id: context 75 + attributes: 76 + label: Additional Context 77 + description: Why is this important? Who would benefit from this improvement? 78 + placeholder: | 79 + - This affects beginners trying to... 80 + - This is a common question in discussions 81 + - This would help with migration from... 82 + 83 + - type: checkboxes 84 + id: confirmations 85 + attributes: 86 + label: Confirmations 87 + description: Please confirm the following 88 + options: 89 + - label: I have checked that this documentation issue hasn't already been reported 90 + required: true 91 + - label: I have reviewed the current documentation thoroughly 92 + required: true
+129
.github/ISSUE_TEMPLATE/feature_request.yml
··· 1 + name: Feature Request 2 + description: Suggest a new feature or enhancement for VoltX.js 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 provide detailed information to help us understand and evaluate your proposal. 10 + 11 + - type: textarea 12 + id: problem 13 + attributes: 14 + label: Problem Statement 15 + description: Describe the problem or use case this feature would solve 16 + placeholder: | 17 + What problem are you trying to solve? What use case would this enable? 18 + Example: "As a developer, I need to..." 19 + validations: 20 + required: true 21 + 22 + - type: textarea 23 + id: solution 24 + attributes: 25 + label: Proposed Solution 26 + description: Describe your proposed solution or feature 27 + placeholder: | 28 + How would you like this to work? What API or attributes would you use? 29 + Be specific about the implementation approach if possible. 30 + validations: 31 + required: true 32 + 33 + - type: textarea 34 + id: alternatives 35 + attributes: 36 + label: Alternatives Considered 37 + description: What alternative solutions or workarounds have you considered? 38 + placeholder: | 39 + - Alternative 1: ... 40 + - Alternative 2: ... 41 + - Current workaround: ... 42 + 43 + - type: dropdown 44 + id: scope 45 + attributes: 46 + label: Feature Scope 47 + description: What part of VoltX would this feature affect? 48 + options: 49 + - Core reactivity (signals, computed, effects) 50 + - Binding system (data-volt-* attributes) 51 + - Expression evaluator 52 + - Plugin system 53 + - HTTP bindings 54 + - Lifecycle hooks 55 + - SSR/Hydration 56 + - Documentation/Examples 57 + - Developer tooling 58 + - Other 59 + validations: 60 + required: true 61 + 62 + - type: dropdown 63 + id: priority 64 + attributes: 65 + label: Priority/Impact 66 + description: How important is this feature to your workflow? 67 + options: 68 + - Critical - Blocking my adoption of VoltX 69 + - High - Would significantly improve my development experience 70 + - Medium - Nice to have, but not urgent 71 + - Low - Minor improvement 72 + validations: 73 + required: true 74 + 75 + - type: textarea 76 + id: size-impact 77 + attributes: 78 + label: Size Constraint Consideration 79 + description: How might this feature impact the 15 KB gzipped constraint? 80 + placeholder: | 81 + Consider: 82 + - Could this be implemented as a plugin instead of core? 83 + - Does this replace existing functionality? 84 + - What's the estimated size impact? 85 + validations: 86 + required: true 87 + 88 + - type: dropdown 89 + id: mode 90 + attributes: 91 + label: Usage Mode 92 + description: Which mode would primarily benefit from this feature? 93 + options: 94 + - Declarative (HTML attributes) 95 + - Programmatic (JavaScript API) 96 + - Both 97 + - Plugin 98 + validations: 99 + required: true 100 + 101 + - type: textarea 102 + id: example 103 + attributes: 104 + label: Example Usage 105 + description: Show how you'd like to use this feature 106 + placeholder: | 107 + <!-- Example HTML or JavaScript --> 108 + render: html 109 + 110 + - type: textarea 111 + id: additional 112 + attributes: 113 + label: Additional Context 114 + description: Any other context, mockups, or references 115 + placeholder: | 116 + - Links to similar features in other frameworks 117 + - Mockups or diagrams 118 + - Related issues or discussions 119 + 120 + - type: checkboxes 121 + id: confirmations 122 + attributes: 123 + label: Confirmations 124 + description: Please confirm the following 125 + options: 126 + - label: I have searched existing issues to ensure this hasn't been requested 127 + required: true 128 + - label: I have considered whether this could be implemented as a plugin 129 + required: true