diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d688555 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,88 @@ +name: Bug report +description: Report broken behavior, regressions, or runtime errors +title: "[Bug]: " +labels: ["bug"] +body: + - type: textarea + id: summary + attributes: + label: Summary + description: What is the bug? + placeholder: "When I type in the search bar, the page jumps to the top." + validations: + required: true + + - type: textarea + id: current_behavior + attributes: + label: Current behavior + description: What happens now? + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected behavior + description: What should happen instead? + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + placeholder: | + 1. Go to '...' + 2. Type '...' + 3. Observe '...' + validations: + required: true + + - type: dropdown + id: frequency + attributes: + label: Frequency + options: + - Always + - Often + - Sometimes + - Rarely + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Scope / impact + description: Who is affected and how severe is it? + placeholder: "Affects all users on search pages; degrades usability." + validations: + required: true + + - type: input + id: environment + attributes: + label: Environment (optional) + placeholder: "OS, browser, app version, route" + validations: + required: false + + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + value: | + - [ ] Bug is reproducible and root cause identified + - [ ] Fix prevents issue from recurring + - [ ] Related flows are verified for regressions + validations: + required: true + + - type: textarea + id: references + attributes: + label: Additional context (optional) + description: Logs, screenshots, links to related issues/PRs. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3de02d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions / Discussions + url: https://github.com/MAY55A/SciBitHub/discussions + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..a78a839 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,82 @@ +name: Documentation +description: Request documentation updates, additions, or clarifications +title: "[Docs]: " +labels: ["documentation"] +body: + - type: dropdown + id: doc_type + attributes: + label: Documentation type + options: + - Missing documentation + - Incorrect/outdated documentation + - Unclear/confusing documentation + - New guide/tutorial needed + - API/reference update + validations: + required: true + + - type: textarea + id: summary + attributes: + label: Summary + description: What documentation needs to change? + validations: + required: true + + - type: textarea + id: location + attributes: + label: Current location (if applicable) + description: Link/file path to existing docs that need updates. + placeholder: "docs/search.md or README.md section" + validations: + required: false + + - type: textarea + id: audience + attributes: + label: Target audience + description: Who is this for? + placeholder: "New contributors, frontend devs, end users, API consumers" + validations: + required: true + + - type: textarea + id: gap + attributes: + label: Problem / gap + description: What confusion or missing info are people experiencing? + validations: + required: true + + - type: textarea + id: proposed + attributes: + label: Proposed content + description: What should be added/changed? + placeholder: | + - Add section on... + - Include examples for... + - Clarify edge cases... + validations: + required: true + + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + value: | + - [ ] Docs updated in the correct location + - [ ] Content reviewed for accuracy + - [ ] Examples/steps tested and clear + validations: + required: true + + - type: input + id: references + attributes: + label: Related links/issues/PRs (optional) + placeholder: "https://github.com/MAY55A/SciBitHub/issues/123" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..3ce300b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,64 @@ +name: Feature request +description: Propose a new capability or product improvement +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem statement + description: What problem are we trying to solve? + placeholder: "Users cannot ..." + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: Describe your proposed approach. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered (optional) + description: Other approaches or why current behavior is insufficient. + validations: + required: false + + - type: textarea + id: users + attributes: + label: Users / impact + description: Who benefits and what value is delivered? + validations: + required: true + + - type: textarea + id: scope + attributes: + label: Scope and constraints (optional) + placeholder: "Out of scope, non-goals, dependencies, risks" + validations: + required: false + + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + value: | + - [ ] Clear user-facing outcome defined + - [ ] Technical approach agreed + - [ ] Success can be validated in QA/UAT + validations: + required: true + + - type: textarea + id: references + attributes: + label: Additional context (optional) + description: Mockups, links, related issues/PRs. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..4145a14 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,68 @@ +name: Task / Chore +description: Track implementation work, refactors, maintenance, or ops tasks +title: "[Task]: " +labels: [] +body: + - type: textarea + id: summary + attributes: + label: Task summary + description: What needs to be done? + validations: + required: true + + - type: textarea + id: objective + attributes: + label: Objective + description: Why are we doing this task? + validations: + required: true + + - type: textarea + id: scope + attributes: + label: Scope + description: What is included and excluded? + placeholder: | + Included: + - ... + Excluded: + - ... + validations: + required: true + + - type: textarea + id: dependencies + attributes: + label: Dependencies / blockers (optional) + placeholder: "Requires PR #..., waiting on issue #..." + validations: + required: false + + - type: textarea + id: deliverables + attributes: + label: Deliverables + description: Concrete outputs expected from this task. + validations: + required: true + + - type: textarea + id: acceptance + attributes: + label: Definition of done + value: | + - [ ] Implementation completed + - [ ] Tests/validation completed + - [ ] Documentation updated (if applicable) + validations: + required: true + + - type: textarea + id: references + attributes: + label: Additional context (optional) + description: Related issues, PRs, docs, logs. + validations: + required: false