diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..a5ec8d506 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**wmk command / config** +Add the `wmk` command or configuration you used here. + +**Logs** +Add relevant logs or error output here. + +**Environment** + - OS: [e.g. Windows 11, Ubuntu 22.04] + - Python version: [e.g. 3.11] + - ModelKit version: [e.g. 0.1.0 or main] + - ONNX Runtime package and version: [e.g. onnxruntime 1.21.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..25aa048a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,27 @@ +name: Feature Request +description: File a feature or enhancement proposal +title: "[FR]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request. + - type: textarea + id: proposal + attributes: + label: Proposal Summary + description: In a few sentences, provide a clear, high-level description of the feature request + validations: + required: true + - type: checkboxes + attributes: + label: What component(s) does this request affect? + description: Please choose one or more components below. + options: + - label: analyze (static analysis, pattern detection) + - label: optim (model optimization, graph rewriting) + - label: inspect (model inspection) + - label: compiler (model compilation) + - label: CLI (wmk commands) + - label: Other diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..a80be75f2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +## Describe your changes + +## Checklist before requesting a review +- [ ] Add unit tests for this change. +- [ ] Make sure all tests can pass. +- [ ] Update documents if necessary. +- [ ] Lint and apply fixes to your code by running `uv run ruff check --fix` +- [ ] Is this a user-facing change? If yes, give a description of this change to be included in the release notes. + +## (Optional) Issue link