Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Issue Templates for Bug Report, Feature Request, Documentation, and General Issues #93

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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_
- **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_

## Additional Context
_Any additional information that might be useful for reproducing the bug or fixing it (e.g., stack trace, logs, screenshots)._

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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"

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.md
Original file line number Diff line number Diff line change
@@ -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._

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.)._

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/general_issue.md
Original file line number Diff line number Diff line change
@@ -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._

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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._

Loading