diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 86016022..f7c0010a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,34 @@ --- name: Bug Report -about: Create a report to help us fix a defect or unexpected behavior -title: 'Fix: [Short description of bug]' +about: Report a defect or unexpected behavior in YieldVault-RWA +title: 'Fix: [Short description of the bug]' labels: 'type: bug, status: needs-triage' assignees: '' --- -## 🐛 Description -Provide a clear and concise description of what the bug is. +## 🐛 Summary +Provide a short summary of the defect and its impact on users, workflows, or system behavior. ## 🔄 Steps to Reproduce -Steps to reproduce the behavior: 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +2. Perform '...' +3. Observe '...' +4. See the error or unexpected result -## 🎯 Expected Behavior -A clear and concise description of what you expected to happen. +## ✅ Expected Behavior +Describe what should have happened. ## ❌ Actual Behavior -A description of what actually happened, including error logs or tracebacks if applicable. +Describe what happened instead, including any errors, logs, or stack traces. -## 🖥️ Environment & Scope -- **Component Scope**: `scope: frontend` / `scope: backend` / `scope: contracts` / `scope: infra` -- **Priority**: `priority: p0-critical` / `priority: p1-high` / `priority: p2-medium` / `priority: p3-low` -- **Environment**: Local / Testnet / Mainnet -- **Browser/OS/Node Version**: e.g., Chrome v120 / Windows / Node v20 +## 📍 Impact +- Affected area: `scope: frontend` / `scope: backend` / `scope: contracts` / `scope: infra` +- Severity / priority: `priority: p0-critical` / `priority: p1-high` / `priority: p2-medium` / `priority: p3-low` +- Environment: Local / Testnet / Mainnet +- Browser / OS / Runtime: e.g. Chrome v120 / Windows / Node v20 -## 📸 Screenshots / Logs -If applicable, add screenshots or logs to help explain your problem. +## 🔎 Evidence +Attach screenshots, console output, logs, or any other information that helps confirm the issue. + +## 📝 Additional Context +Include any relevant commit, deployment, workaround, or suspected cause. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c3246990..e28ca117 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false contact_links: - name: Security Vulnerabilities url: https://github.com/Junirezz/YieldVault-RWA/security/policy - about: Please report security vulnerabilities privately via our Security Policy. + about: Please report security vulnerabilities privately via our Security Policy. Do not post exploit details in public issues. - name: Technical Discussions & Questions url: https://github.com/Junirezz/YieldVault-RWA/discussions about: Ask questions or discuss architectural proposals with the community. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 548c9c44..a45b85fe 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,28 +1,30 @@ --- name: Feature Request about: Suggest an idea or new capability for YieldVault-RWA -title: 'Feature: [Short description of proposed feature]' +title: 'Feature: [Short description of the proposed feature]' labels: 'type: feature, status: needs-triage' assignees: '' --- -## 🚀 Goal & Problem Statement -Is your feature request related to a problem or user need? Please describe. -e.g., "As a vault user, I want to..." +## 🚀 Problem Statement +Describe the user need, pain point, or workflow gap that motivates this request. ## 💡 Proposed Solution -A clear and concise description of what you want to happen and how it should work. +Describe the capability you want and how it should behave. + +## 🎯 Why This Matters +Explain the expected value for users, operators, or the broader platform. ## 📋 Acceptance Criteria - [ ] Requirement 1 - [ ] Requirement 2 -- [ ] Unit / Integration / E2E tests added -- [ ] Relevant documentation updated +- [ ] Tests added or updated where applicable +- [ ] Documentation updated where applicable -## 🏷️ Metadata & Scope -- **Component Scope**: `scope: frontend` / `scope: backend` / `scope: contracts` / `scope: infra` -- **Target Sprint / Milestone**: `sprint: next` / `sprint: backlog` / `sprint: 2026-W30` -- **Priority**: `priority: p1-high` / `priority: p2-medium` / `priority: p3-low` +## 🏷️ Scope & Metadata +- Affected area: `scope: frontend` / `scope: backend` / `scope: contracts` / `scope: infra` +- Target sprint / milestone: `sprint: next` / `sprint: backlog` / `sprint: 2026-W30` +- Priority: `priority: p1-high` / `priority: p2-medium` / `priority: p3-low` ## 🔗 Alternatives Considered -A clear and concise description of any alternative solutions or features you've considered. +Describe any alternative approaches or trade-offs you considered. diff --git a/.github/ISSUE_TEMPLATE/security_report.md b/.github/ISSUE_TEMPLATE/security_report.md new file mode 100644 index 00000000..07ba116a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_report.md @@ -0,0 +1,29 @@ +--- +name: Security Report +about: Report a security vulnerability or security-related concern privately and clearly +title: 'Security: [Short description of the issue]' +labels: 'type: security, status: needs-triage' +assignees: '' +--- + +## 🔐 Summary +Describe the security issue, impact, or suspected vulnerability in a concise way. + +## ⚠️ Impact Assessment +Explain the potential impact on users, funds, permissions, secrets, or platform integrity. + +## 🧭 Reproduction Steps +If available, describe the steps to reproduce the issue or the conditions under which it occurs. + +## 🛡️ Evidence +Include any relevant logs, screenshots, payload samples, or supporting context. Do not include secrets or sensitive exploit details in the issue body. + +## 📍 Scope +- Affected area: `scope: frontend` / `scope: backend` / `scope: contracts` / `scope: infra` +- Severity / priority: `priority: p0-critical` / `priority: p1-high` / `priority: p2-medium` / `priority: p3-low` +- Environment: Local / Testnet / Mainnet + +## 📝 Additional Context +Add any relevant deployment, version, workaround, or mitigation information. + +> Please follow the repository security policy for private disclosure of sensitive vulnerabilities. Do not post exploit details publicly. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8887f3f1..a43c27be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,6 +80,14 @@ To keep our repository organized, we follow a strict branch naming convention. P - **Bug Fixes**: `fix/-` - Example: `fix/350-resolve-auth-crash` +## Issue Reporting Conventions + +When opening a new issue, please use the most appropriate template so the report is actionable for triage: + +- **Bug reports**: use the Bug Report template for defects, crashes, regressions, or unexpected behavior. +- **Feature requests**: use the Feature Request template for new capabilities or enhancements. +- **Security concerns**: use the Security Report template or follow the private security policy for sensitive vulnerabilities. + ## Pull Request Conventions When submitting a Pull Request, please ensure the title is descriptive and follows the format of the issue. The PR body **must** include the following sections: