-
Notifications
You must be signed in to change notification settings - Fork 0
chore(github): add issue templates and update PR template #2441
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,68 @@ | ||
| name: Bug Report | ||
| description: Report a bug in BioETL | ||
| labels: ["bug"] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: What happened? | ||
| placeholder: Describe the bug... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: How can we reproduce this? | ||
| placeholder: | | ||
| 1. Run `bioetl run --pipeline ...` | ||
| 2. ... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected behavior | ||
| description: What should have happened? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: layer | ||
| attributes: | ||
| label: Affected layer | ||
| options: | ||
| - Domain | ||
| - Application | ||
| - Infrastructure | ||
| - Composition | ||
| - Interfaces / CLI | ||
| - Config / Pipeline | ||
| - Unknown | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: provider | ||
| attributes: | ||
| label: Provider (if applicable) | ||
| options: | ||
| - ChEMBL | ||
| - PubChem | ||
| - UniProt | ||
| - PubMed | ||
| - CrossRef | ||
| - OpenAlex | ||
| - Semantic Scholar | ||
| - Composite | ||
| - N/A | ||
|
|
||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant logs | ||
| description: Paste any error output or logs | ||
| render: shell | ||
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,41 @@ | ||
| name: Feature Request | ||
| description: Suggest a new feature or improvement | ||
| labels: ["enhancement"] | ||
| body: | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem | ||
| description: What problem does this solve? | ||
| placeholder: I'm frustrated when... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Proposed solution | ||
| description: How should this work? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: scope | ||
| attributes: | ||
| label: Scope | ||
| options: | ||
| - New pipeline / provider | ||
| - Existing pipeline enhancement | ||
| - Data quality / validation | ||
| - CLI / UX | ||
| - Performance | ||
| - Infrastructure / DevOps | ||
| - Documentation | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| description: Any other approaches you considered? |
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 |
|---|---|---|
| @@ -1,16 +1,39 @@ | ||
| ## Summary | ||
|
|
||
| <!-- Brief description of what this PR does --> | ||
| <!-- Brief description of changes (1-3 sentences) --> | ||
|
|
||
| ## Changes | ||
|
|
||
| - | ||
|
|
||
| ## Type | ||
|
|
||
| - [ ] Bug fix | ||
| - [ ] New feature | ||
| - [ ] Refactoring (no functional changes) | ||
| - [ ] Config / pipeline change | ||
| - [ ] Documentation | ||
| - [ ] CI / infrastructure | ||
|
|
||
| ## Affected layers | ||
|
|
||
| - [ ] Domain | ||
| - [ ] Application | ||
| - [ ] Infrastructure | ||
| - [ ] Composition | ||
| - [ ] Interfaces | ||
| - [ ] Configs | ||
|
|
||
| ## Test plan | ||
|
|
||
| - [ ] Unit tests pass (`pytest tests/unit/`) | ||
| - [ ] Architecture tests pass (`pytest tests/architecture/`) | ||
| - [ ] Type check passes (`mypy --strict src/bioetl/`) | ||
| - [ ] Manual verification (describe below if applicable) | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] `make lint` passes | ||
| - [ ] `make test` passes | ||
| - [ ] No hardcoded secrets or credentials | ||
| - [ ] Architecture tests pass (`pytest tests/architecture/ -v`) | ||
| - [ ] Documentation updated if behavior changed | ||
| - [ ] Follows Conventional Commits format | ||
| - [ ] No new import boundary violations (ARCH-001) | ||
| - [ ] No hardcoded secrets (AP-005) | ||
| - [ ] Type annotations on all public functions (TYPE-001) | ||
| - [ ] Tests added/updated for new code (TEST-002) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding this issue form while keeping
.github/ISSUE_TEMPLATE/bug_report.md(and similarlyfeature_request.md) creates duplicate entries in GitHub’s template chooser with the same names, so reporters can still select the old Markdown templates and skip the required structured fields/dropdowns introduced here. This undermines the purpose of the new form-based triage data and is likely to degrade issue quality until the legacy templates are removed or disabled via template config.Useful? React with 👍 / 👎.