From d4b76857c0e7b0cd8cbd47c18898f744cc107c97 Mon Sep 17 00:00:00 2001 From: Gregory Horvath Date: Mon, 28 Oct 2024 18:47:03 -0400 Subject: [PATCH] chore: add pr and issue templates --- .github/ISSUE_TEMPLATE/.gitkeep | 0 .github/ISSUE_TEMPLATE/bug_report.md | 22 +++++++++++++++++ .github/ISSUE_TEMPLATE/chore.md | 24 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++++++++ .../pull_request_template.md | 22 +++++++++++++++++ 5 files changed, 90 insertions(+) delete mode 100644 .github/ISSUE_TEMPLATE/.gitkeep create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/chore.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/.gitkeep b/.github/ISSUE_TEMPLATE/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..8c6dca8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,22 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Description +Provide a clear and concise description of the bug. + +## Steps to Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. See the error + +## Expected Behavior +Provide a clear and concise description of what you expected to happen. + +## Additional Context +Add any other context about the problem here (e.g., screenshots, environment, versions, etc.). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md new file mode 100644 index 0000000..a5425ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/chore.md @@ -0,0 +1,24 @@ +--- +name: Chore +about: Maintenance, refactoring, and housekeeping tasks +title: '[CHORE] ' +labels: chore +assignees: '' +--- + +## Description +Provide a brief description of the chore needed. + +## Motivation +Why is this chore important? What problems does it solve or prevent? + +## Technical Details +Include any specific technical details, dependencies, or areas that will be affected. + +## Risk Assessment +- Impact level: (Low/Medium/High) +- Areas affected: +- Potential side effects: + +## Additional Notes +Include any other relevant information or context. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..243bb20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Story + +**As a** [persona], +**I want** [feature], +**so that** [benefit]. + +## Proposed Solution +Provide a clear description of what you want to happen. + +## Alternatives Considered +Provide a clear description of any alternative solutions or features you've considered. + +## Additional Context +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..7877f9a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,22 @@ +## Description +Brief description of the changes + +## Type of change +- [ ] Bug fix +- [ ] New feature +- [ ] Breaking change +- [ ] Documentation update + +## How Has This Been Tested? +Describe how you tested these changes. + +## Checklist: + +- [ ] Your code is clean, understandable, and commented. +- [ ] All workflows are passing. +- [ ] You have sought at least one review from a key contributor or code owner. +- [ ] Tests are written to prevent recurrence of any known bugs. +- [ ] Documentation is sufficient for other contributors (or your future self) to work with your code. + +## Related Issues +Fixes #(issue) \ No newline at end of file