diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..80fd174 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,49 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug"] +body: + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Run command '...' + 2. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened. + validations: + required: true + - type: input + id: environment + attributes: + label: Environment + description: OS, Python version, modelinfo-cli version + placeholder: e.g. Ubuntu 22.04, Python 3.10.12, v1.4.1 + validations: + required: true + - type: textarea + id: logs + attributes: + label: Additional Context or Logs + description: Add any other context about the problem here, or paste relevant tracebacks. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..0385555 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,30 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem Description + description: Is your feature request related to a problem? Please describe. + placeholder: I'm always frustrated when... + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a466d4c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +## Summary + +Provide a brief summary of what this PR accomplishes. + +## Motivation & Context + +Why is this change required? What problem does it solve? +If it fixes an open issue, please link to the issue here. + +## Type of Change + +- [ ] 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 not work as expected) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. +Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. + +- [ ] Unit tests +- [ ] Integration tests +- [ ] Manual testing + +## Screenshots (if appropriate) + +## Checklist + +- [ ] My code follows the code style of this project. +- [ ] My commit messages follow the Conventional Commits format, are lowercase, imperative, and specific. +- [ ] My commit includes a "How to test" section in the body. +- [ ] I have updated the documentation accordingly (if applicable). +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed.