Skip to content

Commit

Permalink
docs: add PR and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
CelticBoozer committed Oct 1, 2024
1 parent fdc9d38 commit 03b5681
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
name: Bug Report
about: Report a bug or issue with the dotfiles configuration
title: "[Bug] Brief Description of Issue"
labels: bug
assignees: ''

---

## Describe the Bug

<!--
A clear and concise description of what the bug is. Please include any error
messages or unexpected behavior.
-->

## Steps to Reproduce

<!--
Please provide detailed steps to reproduce the issue.
Example:
1. Use the .bashrc or sway config from the latest commit
2. Open terminal
3. Run `command_name`
4. See error
-->

## Expected Behavior

<!--
A clear and concise description of what you expected to happen.
-->

## Screenshots (if applicable)

<!--
If applicable, add screenshots to help explain your problem.
-->

## System Information

<!--
Include information about your system.
Example:
- OS: Arch Linux
- Window Manager: Sway
- Shell: Zsh
- Any other relevant information (e.g., terminal emulator, display server)
-->

## Dotfiles Version

<!--
Specify the commit hash or the branch you are using.
-->

## Additional Context

<!--
Add any other context about the problem here.
-->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature Request
about: Suggest a new feature or improvement to the dotfiles
title: "[Feature] Brief Description of the Feature"
labels: enhancement
assignees: ''

---

## Feature Description

<!--
A clear and concise description of the feature or improvement you would like to see.
-->

## Why This Feature Is Necessary

<!--
Explain why this feature would be useful or needed in your setup.
-->

## Suggested Implementation

<!--
If you have ideas about how this feature could be implemented or configured,
please describe them here.
-->

## Additional Notes

<!--
Add any other information or context related to the feature request.
-->
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Configuration Question
about: Ask a question about the configuration or seek help with setup
title: "[Question] Brief Description of Your Question"
labels: question
assignees: ''

---

## Question

<!--
Describe your question or the configuration problem you are facing.
Example: How do I switch between keyboard layouts in Sway using Alt+Shift?
-->

## System Information

<!--
Provide system details if relevant to your question.
Example:
- OS: Ubuntu
- Window Manager: i3
- Shell: Bash
- Any other details that might help troubleshoot.
-->

## Additional Context

<!--
Add any other details or screenshots to clarify your question.
-->
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Description

<!--
Please provide a brief summary of the changes you made and why they are necessary.
Example: Added new aliases to .bashrc for improved workflow efficiency.
-->

## Type of Change

<!--
Please check the relevant option by placing an "x" inside the brackets [x].
-->

- [ ] Bug fix
- [ ] New feature/configuration
- [ ] Refactoring (no functional changes)
- [ ] Documentation update
- [ ] Other (please describe):

## Checklist

<!--
Ensure that your PR adheres to the following requirements.
-->

- [ ] I have read and followed the [CONTRIBUTING.md](CONTRIBUTING.md) (if applicable).
- [ ] The code or configuration is properly tested.
- [ ] All changes are documented in the appropriate `.md` file or within comments.
- [ ] No configuration files (e.g., `.bashrc`, `.zshrc`, `sway/config`) are
broken or misconfigured.
- [ ] I have manually verified that all new configurations work as expected.
- [ ] I have updated the README or documentation if necessary.
- [ ] I have considered backward compatibility for existing setups.
- [ ] I have linted and formatted my code/config files if applicable.

## Testing

<!--
Please describe how you tested the changes you made.
Example: Tested on Arch Linux with Sway and Zsh.
-->

## Screenshots (if applicable)

<!--
If the changes involve visual updates (e.g., i3 or Sway configuration), include screenshots.
-->

## Additional Notes

<!--
Add any other information you think is important or relevant to this PR.
-->

0 comments on commit 03b5681

Please sign in to comment.