diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..49eb1723 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,58 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +## 🐞 Bug Summary + +Describe the issue you're experiencing with the core module, such as a rule not behaving as expected, incorrect scan output, or problems with configuration or parsing. + +--- + +## 🔁 Reproduction Steps + +Steps to reproduce the bug: + +1. Configure rule(s): `...` +2. Run `scan(...)` with input: `...` +3. Observe: `...` (unexpected result, exception, etc.) + +--- + +## ✅ Expected Behavior + +Describe what *should* have happened. Be specific about expected rule evaluation or output. + +--- + +## 📄 Sample Input / Configuration + +If applicable, include: + +- JSON/YAML rule config +- Example flow metadata (anonymized) +- Command-line usage or API invocation (e.g. `scan(...)`, `parse(...)`, `fix(...)`) + +--- + +## 📋 Environment + +- **OS**: [e.g. macOS Ventura, Ubuntu 22.04] +- **Node.js Version**: [e.g. 18.16.0] +- **NPM Version**: [e.g. 9.5.1] +- **Module Version**: [e.g. `lightning-flow-scanner-core` v1.4.0] +- **Used via**: [Direct, VS Code extension, Salesforce CLI plugin] + +--- + +## 📚 Additional Context + +Any other details? Paste relevant error logs, stack traces, or screenshots that illustrate the issue. + +--- + +> ⚠️ Note: If this issue affects the **VS Code Extension** or **Salesforce CLI Plugin**, please file it in the relevant repository instead. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..6ff7ac7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. For example: "I'm always frustrated when [...]" + +**Describe the solution you'd like** +A clear and concise description of what you want to happen in the core engine (e.g., API improvement, config support, new CLI flag, etc.). + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or workarounds you've considered. + +**Additional context** +Add any other context or examples (including CLI usage, integration notes, etc.) here. diff --git a/.github/ISSUE_TEMPLATE/rule-request.md b/.github/ISSUE_TEMPLATE/rule-request.md new file mode 100644 index 00000000..3583cbb5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rule-request.md @@ -0,0 +1,23 @@ +--- +name: Rule request +about: Suggest a new static analysis rule for flows +title: '' +labels: new rule +assignees: '' + +--- + +**Is your rule request related to a specific problem or anti-pattern? Please describe.** +A clear and concise description of the issue this rule should detect. For example: "Flows using 'Get Records' with 'store all fields' should be flagged." + +**Describe the rule you'd like to see** +Outline the behavior the rule should enforce or detect. + +**Describe alternatives you've considered** +If there's another way to enforce this pattern today, mention it here. + +**Example flow behavior (optional)** +If you can, describe or attach an example Flow structure or metadata where this rule would apply. + +**Additional context** +Add any other context, links to docs, or notes relevant to the rule idea.