Skip to content

Commit

Permalink
Merge pull request #16 from Kerosene-Labs/rework-issue-templates
Browse files Browse the repository at this point in the history
initial
  • Loading branch information
hlafaille authored Nov 6, 2024
2 parents 6d6fa48 + 9bf041f commit da4a240
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 33 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/issue_template.md

This file was deleted.

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

0 comments on commit da4a240

Please sign in to comment.