diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6dee059 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..41178d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3feb496 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ +## Description + + + +## Motivation and Context + + + + + +## How Has This Been Tested? + + + + + +## Screenshots / Logs (if applicable) + +## Types of Changes + + + +- [ ] 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: + + + + +- [ ] 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. + +