From a311225616d5efedc1a7d727d6ba62175b7997a1 Mon Sep 17 00:00:00 2001 From: "Pratiksha B. Gaikwad" Date: Tue, 12 Nov 2024 01:26:12 -0500 Subject: [PATCH 1/2] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++ .github/ISSUE_TEMPLATE/documentation_issue.md | 21 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++ .github/ISSUE_TEMPLATE/general_issue.md | 32 ++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 23 +++++++++++++ 6 files changed, 140 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/general_issue.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1feb62d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior in the project. +title: "[Bug] " +labels: bug +assignees: '' +--- + +## Description +_A clear and concise description of the bug or issue you encountered._ + +## Steps to Reproduce +1. Step 1 +2. Step 2 +3. Step 3 + +_Include any steps to reproduce the issue._ + +## Expected Behavior +_What you expected to happen._ + +## Actual Behavior +_What actually happened (error messages, unexpected results, etc.)._ + +## Versions +- **Operating System**: _e.g., Windows 10, macOS, Ubuntu 20.04_ +- **Version**: _e.g., 1.2.3_ +- **Dependencies**: _e.g., Python 3.8.5, Node.js 14.x, etc._ +- **Browser (if applicable)**: _e.g., Chrome 92, Firefox 89_ + +## Additional Context +_Any additional information that might be useful for reproducing the bug or fixing it (e.g., stack trace, logs, screenshots)._ + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..69f8370 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +# Default issue template configuration + +# Set the default template for issues when a user doesn't choose a template. +default: + name: "Bug Report" + description: "A bug or issue encountered while using the project." + labels: "bug" + diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md new file mode 100644 index 0000000..eeeef4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_issue.md @@ -0,0 +1,21 @@ +--- +name: Documentation Issue +about: Report an issue with the documentation or suggest improvements. +title: "[Documentation Issue] " +labels: documentation +assignees: '' +--- + +## Description +_A clear description of the issue with the documentation (e.g., unclear, outdated, missing information)._ + +## Location of Issue +- **Page URL**: _If this issue is related to a specific page, provide the URL or section name._ +- **Line Numbers**: _If applicable, provide the line numbers of the relevant section in the documentation._ + +## Suggested Changes +_What changes or improvements would you suggest for the documentation? If possible, provide a clear, updated version of the section or explanation._ + +## Additional Context +_Provide any additional context or examples that might help clarify the issue or your suggestion._ + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1f07749 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement to the project. +title: "[Feature Request] " +labels: enhancement +assignees: '' +--- + +## Summary +_A brief summary of the feature or enhancement you are requesting._ + +## Motivation +_Why is this feature or enhancement needed? What problem does it solve or how does it improve the project?_ + +## Proposed Solution +_A clear description of what you are proposing. If applicable, describe the design or implementation approach._ + +## Alternatives +_Are there any alternative solutions or approaches that have been considered?_ + +## Additional Context +_Provide any additional context or information that might help (e.g., use cases, relevant research, design mocks, etc.)._ + diff --git a/.github/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md new file mode 100644 index 0000000..4f1bce8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_issue.md @@ -0,0 +1,32 @@ +--- +name: General Issue +about: Report a general issue or something not covered by the other templates. +title: "[General Issue] " +labels: question, bug, enhancement, or any relevant labels +assignees: '' +--- + +## Description +_A clear description of the issue, suggestion, or concern._ + +## Steps to Reproduce (if applicable) +1. Step 1 +2. Step 2 +3. Step 3 + +_If the issue can be reproduced, include the steps to reproduce it._ + +## Expected Behavior +_What you expected to happen._ + +## Actual Behavior +_What actually happened (error messages, unexpected results, etc.)._ + +## Environment +- **Operating System**: _e.g., Windows 10, macOS, Ubuntu 20.04_ +- **Version**: _e.g., 1.2.3_ +- **Dependencies**: _e.g., Python 3.8.5, Node.js 14.x, etc._ + +## Additional Context +_Any other relevant information or context, such as logs, stack traces, screenshots, etc._ + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..15ae993 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,23 @@ +--- +name: Question +about: Ask a question or seek clarification about the project. +title: "[Question] " +labels: question +assignees: '' +--- + +## Question +_A clear and concise description of your question or issue you're facing._ + +## Context +_Provide any context that could help us better understand your question. For example, are you using the project in a specific environment, or have you encountered a roadblock while using a particular feature?_ + +## Steps Taken So Far +_What steps have you already taken to try to resolve the issue (e.g., reading documentation, searching for similar issues, etc.)?_ + +## Expected Outcome +_What did you expect to happen or understand?_ + +## Additional Context +_Any additional information that could help, such as code snippets, error logs, or specific use cases._ + From 12181b253724d38a416aca78cc691da0b7481440 Mon Sep 17 00:00:00 2001 From: "Pratiksha B. Gaikwad" Date: Tue, 12 Nov 2024 01:28:21 -0500 Subject: [PATCH 2/2] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1feb62d..a2206b0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,7 +24,7 @@ _What actually happened (error messages, unexpected results, etc.)._ ## Versions - **Operating System**: _e.g., Windows 10, macOS, Ubuntu 20.04_ -- **Version**: _e.g., 1.2.3_ +- **PyCI Version**: _e.g., 1.2.3_ - **Dependencies**: _e.g., Python 3.8.5, Node.js 14.x, etc._ - **Browser (if applicable)**: _e.g., Chrome 92, Firefox 89_