Skip to content

Commit

Permalink
Added pull_request_template and created issue templates for bug repor…
Browse files Browse the repository at this point in the history
…ts and feature requests
  • Loading branch information
Emkay2309 committed Sep 15, 2024
1 parent 643c385 commit eb295ae
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---
## 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.

## Environment:
- OS: [e.g., Windows, MacOS, Linux]
- Browser [e.g., Chrome, Safari]
- Version [e.g., 22]

## Additional context
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---
## 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.
37 changes: 36 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,42 @@
# Description

[Provide a brief description of the changes introduced by this pull request. Explain the purpose and goals of the changes.]
[Please include a summary of the changes and the motivation behind them.]

# Testing

[Describe the steps you followed to test the changes made in this PR.]
[Describe the steps you followed to test the changes made in this PR. Include details about the environment, configurations, and any test cases.]


# Related Issue

[If this PR addresses an open issue, link it here (e.g., #4).]


## Type of Change / Changes Made

- [List the key changes made in this PR. (e.g., below)]

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## Checklist:
- [ ] I have read the contributing guidelines
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes do not introduce any new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes


# Screenshots (if applicable)

[Add screenshots or GIFs to explain the visual changes in this PR.]

# Additional Information

[Provide any additional context or information about this PR.]

0 comments on commit eb295ae

Please sign in to comment.