Update for contributing

5 files changed, 179 insertions, 0 deletions

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..5581581a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug]: Short description of the issue"
+labels: "Something isn't working"
+---
+
+## Bug Report
+
+### Description
+
+[Provide a clear and concise description of the bug.]
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+### Expected Behavior
+
+[What did you expect to happen?]
+
+### Actual Behavior
+
+[What actually happened?]
+
+### Screenshots
+
+[If applicable, add screenshots to help explain your problem.]
+
+### Environment
+
+[Please add any other relevant information about the bug and remove the unnecessary lines.]
+
+e.g.,
+
+- Linux Distro: [e.g., ArchLinux, Debian, Fedora 39, OpenSuse]
+- Linux Version, output of `uname -a`:
+- Hyprland Version, output of `hyprctl version`:
+- Installation Environment: [e.g., On The Main Hardware, On A Virtual Machine]
+- Other info: [e.g., Display Resolution, Resolution, etc]
+
+### Additional Information
+
+[Add any other information about the problem here. For example, you might include the error message, any recent changes that you made to the project, or any other relevant details.]
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 00000000..1542d0a8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,38 @@
+---
+name: Custom template
+about: Use this template to submit a custom issue
+title: "[Custom]: Short description of the issue"
+labels: "custom"
+---
+
+## Custom Template
+
+### Description
+
+[Provide a clear and concise description of the issue or request.]
+
+### Steps to Reproduce (if applicable)
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+### Expected Behavior
+
+[What did you expect to happen?]
+
+### Actual Behavior
+
+[What actually happened?]
+
+### Screenshots (if applicable)
+
+[If applicable, add screenshots to help explain your problem.]
+
+### Proposed Solution (if applicable)
+
+[If you have a specific solution in mind, describe it here. If not, you can skip this section.]
+
+### Additional Information
+
+[Add any other information about the issue or request here. For example, you might include links to similar features in other projects, or screenshots or diagrams to help explain your idea.]
diff --git a/.github/ISSUE_TEMPLATE/documentation_update.md b/.github/ISSUE_TEMPLATE/documentation_update.md
new file mode 100644
index 00000000..b75d92f0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_update.md
@@ -0,0 +1,24 @@
+---
+name: Documentation update
+about: Propose a change to the project documentation
+title: "[Docs]: Short description of the change"
+labels: "documentation update"
+---
+
+## Documentation Update
+
+### Description
+
+[Provide a clear and concise description of the documentation update you'd like to see made.]
+
+### Current Documentation
+
+[Provide a link to the current documentation or describe where it can be found.]
+
+### Proposed Documentation
+
+[Provide a clear and concise description of the updated documentation that you'd like to see added.]
+
+### Additional Information
+
+[Add any other information about the documentation update here. For example, you might include links to similar documentation in other projects, or screenshots or diagrams to help explain your idea.]
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..bd64d0a0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest a feature for this project
+title: "[Feature Request]: Short description of the feature"
+labels: "enhancement, needs triage, feature request"
+---
+
+## Feature Request
+
+### Description
+
+[Provide a clear and concise description of the feature you'd like to see added.]
+
+### Use Case
+
+[Describe how this feature would be useful to you or to other users of the project.]
+
+### Proposed Solution
+
+[If you have a specific solution in mind, describe it here. If not, you can skip this section.]
+
+### Alternatives
+
+[Are there any alternative solutions or workarounds that you've considered? If so, describe them here.]
+
+### Additional Information
+
+[Add any other information about the feature request here. For example, you might include links to similar features in other projects, or screenshots or diagrams to help explain your idea.]
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..42811c53
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,43 @@
+# Pull Request
+
+## Description
+
+Please read these instructions and remove unnecessary text.
+
+- Try to include a summary of the changes and which issue is fixed.
+- Also include relevant motivation and context (if applicable).
+- List any dependencies that are required for this change. (e.g., packages or other PRs)
+- Provide a link if there is an issue related to this pull request. e.g., Fixes # (issue)
+- Please add Reviewers, Assignees, Labels, Projects, and Milestones to the PR. (if applicable)
+
+## Type of change
+
+Please put an `x` in the boxes that apply:
+
+- [ ] **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)
+- [ ] **Documentation update** (non-breaking change; modified files are limited to the documentations)
+- [ ] **Technical debt** (a code change that does not fix a bug or add a feature but makes something clearer for devs)
+- [ ] **Other** (provide details below)
+
+## Checklist
+
+Please put an `x` in the boxes that apply:
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md) document.
+- [ ] My code follows the code style of this project.
+- [ ] My commit message follows the [commit guidelines](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md#git-commit-messages).
+- [ ] My change requires a change to the documentation.
+- [ ] I want to add something in Hyprland-Dots wiki.
+- [ ] I have added tests to cover my changes.
+- [ ] I have tested my code locally and it works as expected.
+- [ ] All new and existing tests passed.
+
+## Screenshots
+
+(if appropriate)
+
+## Additional context
+
+Add any other context about the problem here.