-
Notifications
You must be signed in to change notification settings - Fork 3
chore: add standardized GitHub issue templates and disable blank issues #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.