From 9bf041f7b7b67100c27a3f8682bb1017887c0cf0 Mon Sep 17 00:00:00 2001 From: Hunter LaFaille Date: Wed, 6 Nov 2024 17:21:37 +0000 Subject: [PATCH] initial --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 20 +++++++++++ .github/ISSUE_TEMPLATE/feature.md | 20 +++++++++++ .github/ISSUE_TEMPLATE/issue_template.md | 33 ------------------- .../PULL_REQUEST_TEMPLATE.md | 26 +++++++++++++++ 5 files changed, 96 insertions(+), 33 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md delete mode 100644 .github/ISSUE_TEMPLATE/issue_template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e1bd83c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug Report +about: Report a bug in the project +title: "[Bug] " +labels: bug +assignees: '' + +--- + +## Description +A clear and concise description of what the bug is. + +## Steps to Reproduce +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. + +## Environment +- OS: [e.g., Windows, macOS, Linux] +- Version: [e.g., v1.0.0] + +## Additional Context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..46ceb8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,20 @@ +--- +name: Documentation Request +about: Request for documentation improvements or additions +title: "[Documentation] " +labels: documentation +assignees: '' + +--- + +## Summary +A brief summary of the documentation change or addition you are suggesting. + +## Current Documentation Location +Where the current documentation can be found (URL or section). + +## Suggested Changes +A clear and concise description of what you would like to see changed or added. + +## Additional Context +Add any other context or details relevant to your request. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..903f3f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: Suggest a new feature for the project +title: "[Feature] " +labels: enhancement +assignees: '' + +--- + +## Is your feature request related to a problem? Please describe. +A clear and concise description of the problem you want to solve. + +## 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. diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md deleted file mode 100644 index eda708e..0000000 --- a/.github/ISSUE_TEMPLATE/issue_template.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug Report / Feature Request / General Inquiry -about: Create a report to help us improve or ask a question -title: '' -labels: '' -assignees: '' - ---- - -**Issue Type** -- [ ] Bug Report -- [ ] Feature Request -- [ ] General Inquiry - -**Description** -Provide a clear and concise description of what the issue or request is. - -**Steps to Reproduce (for bugs)** -1. Step one -2. Step two -3. Step three - -**Expected Behavior** -Describe what you expected to happen. - -**Actual Behavior (for bugs)** -Describe what actually happened. - -**Screenshots/Logs** -If applicable, add screenshots or logs to help explain the issue. - -**Environment** -Please 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..0f2717e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +--- +name: Pull Request +about: Submit a pull request to the project +title: "[PR] " +labels: '' +assignees: '' + +--- + +## Description +A clear and concise description of what your pull request does. + +## Related Issues +Link any related issues (e.g., fixes #123). + +## Type of Change +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Other (please specify) + +## How to Test +Instructions on how to test your changes. + +## Additional Context +Any other context about your pull request.