From b17b08437a193b04b5ba48dd083437ceb4f14cd1 Mon Sep 17 00:00:00 2001 From: Simon Roy <49426163+PenguinBoi12@users.noreply.github.com> Date: Wed, 1 Jul 2026 01:16:54 -0400 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature--good-first.md | 29 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++++++++ 3 files changed, 78 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature--good-first.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3f3ea3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: PenguinBoi12 +type: Bug + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature--good-first.md b/.github/ISSUE_TEMPLATE/feature--good-first.md new file mode 100644 index 0000000..af2318a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature--good-first.md @@ -0,0 +1,29 @@ +--- +name: 'Feature: Good First' +about: 'This template is for good first issues ' +title: '' +labels: good first issue +assignees: '' +type: Feature + +--- + +Explain clearly what we want to add and why it's useful to add it. Give context when necessary. + +### Proposed API +This is a proposed API. It does not necessarily mean it's the final API but it's a good place to start. + +```python +Some code here +``` + +**Example** +```python +An example of usage of the feature +``` + +### Before opening a PR +- Write unit tests +- Run `mypy matrix/` +- Run `pytest tests/` +- Run `black .` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..e255ea9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' +type: Feature + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.