-
Notifications
You must be signed in to change notification settings - Fork 70
chore: add GitHub issue and PR templates #564
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
Open
ognis1205
wants to merge
6
commits into
always-further:main
Choose a base branch
from
ognis1205:docs/add-github-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
561a222
chore: add github bug report issue template
ognis1205 be84d8e
chore: add github feature request issue template
ognis1205 624b6d7
chore: add github pr template
ognis1205 c6978b9
chore: address gemini suggestions
ognis1205 2941fd9
chore: address gemini suggestions
ognis1205 201654b
docs: update bug_report.yml
ognis1205 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,69 @@ | ||
| name: Bug report 🐛 | ||
| description: Report a bug to help us improve | ||
| labels: ['bug'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: checkboxes | ||
| id: new-bug | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please search to see if an issue already exists for the bug you encountered. | ||
| options: | ||
| - label: I have searched the existing issues | ||
| required: true | ||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Description of the bug | ||
| description: Tell us what bug you encountered and what should have happened. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Steps to reproduce the behavior. | ||
| placeholder: | | ||
| Please tell us how to reproduce this bug, for example: | ||
| 1. Install dependencies with 'uv pip install -r requirements.txt' | ||
| 2. Run the script with 'python main.py ...' | ||
| 3. Use the following configuration options, if any | ||
| 4. Observe the error | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| description: What should be the expected behavior. | ||
| placeholder: A clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots / Logs | ||
| description: If applicable, add screenshots to help explain your problem. | ||
| placeholder: Paste your screenshots here. | ||
| - type: textarea | ||
| id: software-info | ||
| attributes: | ||
| label: Software information | ||
| description: | | ||
| Please provide the following information about your environment. | ||
| Run `deepfabric --version` to get the DeepFabric version. | ||
| value: | | ||
| - Operating system: | ||
| - Python version: | ||
| - DeepFabric version: | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional context | ||
| description: Do you want to share any additional context about this bug? | ||
| placeholder: Add any other context about the problem 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,46 @@ | ||
| name: Feature request ⛰️ | ||
| description: Suggest an idea for this project | ||
| labels: ['enhancement'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for suggesting this feature! | ||
| - type: checkboxes | ||
| id: new-feature | ||
| attributes: | ||
| label: Is there an existing issue or pull request for this? | ||
| description: Please search to see if an issue or pull request already exists for the feature you desire. | ||
| options: | ||
| - label: I have searched the existing issues and pull requests | ||
| required: true | ||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Feature description | ||
| description: Is your feature request related to a problem? Please describe. | ||
| placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: desired-solution | ||
| attributes: | ||
| label: Desired solution | ||
| description: Describe the solution you'd like. | ||
| placeholder: A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives-considered | ||
| attributes: | ||
| label: Alternatives considered | ||
| description: Describe alternatives you've considered. | ||
| placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional context | ||
| description: Do you want to share any additional context about this feature? | ||
| placeholder: Add any other context about the feature 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,42 @@ | ||
| ## Description | ||
|
|
||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ## Motivation and Context | ||
|
|
||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
| <!--- You can use keywords like "Closes #123" or "Fixes #123" to automatically close the issue on merge. --> | ||
|
|
||
| ## How Has This Been Tested? | ||
|
|
||
| <!--- Please describe in detail how you tested your changes. --> | ||
| <!--- Include details of your testing environment, and the tests you ran to --> | ||
| <!--- see how your change affects other areas of the code, etc. --> | ||
|
|
||
| ## Screenshots / Logs (if applicable) | ||
|
|
||
| ## Types of Changes | ||
|
|
||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
|
|
||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
| - [ ] Documentation (no code change) | ||
| - [ ] Refactor (code restructuring with no functional changes) | ||
| - [ ] Other (please describe) | ||
|
|
||
| ## Checklist: | ||
|
|
||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
|
|
||
| - [ ] My code follows the code style of this project. | ||
| - [ ] I have updated the documentation accordingly. | ||
| - [ ] I have formatted the code with [ruff](https://github.com/astral-sh/ruff) (`uv run ruff format deepfabric/ tests/`). | ||
| - [ ] I checked the lints with [ruff](https://github.com/astral-sh/ruff) (`uv run ruff check . --exclude notebooks/`). | ||
| - [ ] I have added tests to cover my changes. | ||
| - [ ] All new and existing tests passed. | ||
|
|
||
| <!--- Thank you for contributing to deepfabric! ⛰️ --> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.