Merge pull request #46 from JaKooLit/main

synchronize main and development branch

.github/FUNDING.yml

@@ -2,4 +2,3 @@
 
 github: JaKooLit
 ko_fi: jakoolit
-

.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., Debian 13, SID , Ubuntu 23.10, etc]
+- 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.]

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

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

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

.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/Debian-Hyprland/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/Debian-Hyprland/blob/main/CONTRIBUTING.md#git-commit-messages).
+- [ ] My change requires a change to the documentation.
+- [ ] I want to add something in Debian-Hyprland 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.

CHANGELOGS.md

@@ -1,5 +1,8 @@
 ## Changelogs
 
+## 20 Apr 2024
+- Change default Oh-my-zsh theme to xiong-chiamiov-plus
+
 ## 11 Jan 2024
 - dropped wlsunset
 - added hyprlang build and install

COMMIT_MESSAGE_GUIDELINES.md

@@ -0,0 +1,149 @@
+# Commit Message Guidelines
+
+A good commit message should be descriptive and provide context about the changes made. This makes it easier to understand and review the changes in the future.
+
+Here are some guidelines for writing descriptive commit messages:
+
+- Start with a short summary of the changes made in the commit.
+
+- Use imperative mood for the summary, as if you're giving a command. For example, "Add feature" instead of "Added feature".
+
+- Provide additional details in the commit message body, if necessary. This could include the reason for the change, the impact of the change, or any dependencies that were introduced or removed.
+
+- Keep the message within 72 characters per line to ensure that it's easy to read in Git log output.
+
+Examples of good commit messages:
+
+- "Add authentication feature for user login"
+- "Fix bug causing application to crash on startup"
+- "Update documentation for API endpoints"
+
+Remember, writing descriptive commit messages can save time and frustration in the future, and help others understand the changes made to the codebase.
+
+## Commit Message Types
+
+Here's a more comprehensive list of commit types that you can use:
+
+`feat`: Adding a new feature to the project
+
+```markdown
+feat: Add multi-image upload support
+```
+
+`fix`: Fixing a bug or issue in the project
+
+```markdown
+fix: Fix bug causing application to crash on startup
+```
+
+`docs`: Updating documentation in the project
+
+```markdown
+docs: Update documentation for API endpoints
+```
+
+`style`: Making cosmetic or style changes to the project (such as changing colors or formatting code)
+
+```markdown
+style: Update colors and formatting
+```
+
+`refactor`: Making code changes that don't affect the behavior of the project, but improve its quality or maintainability
+
+```markdown
+refactor: Remove unused code
+```
+
+`test`: Adding or modifying tests for the project
+
+```markdown
+test: Add tests for new feature
+```
+
+`chore`: Making changes to the project that don't fit into any other category, such as updating dependencies or configuring the build system
+
+```markdown
+chore: Update dependencies
+```
+
+`perf`: Improving performance of the project
+
+```markdown
+perf: Improve performance of image processing
+```
+
+`security`: Addressing security issues in the project
+
+```markdown
+security: Update dependencies to address security issues
+```
+
+`merge`: Merging branches in the project
+
+```markdown
+merge: Merge branch 'feature/branch-name' into develop
+```
+
+`revert`: Reverting a previous commit
+
+```markdown
+revert: Revert "Add feature"
+```
+
+`build`: Making changes to the build system or dependencies of the project
+
+```markdown
+build: Update dependencies
+```
+
+`ci`: Making changes to the continuous integration (CI) system for the project
+
+```markdown
+ci: Update CI configuration
+```
+
+`config`: Making changes to configuration files for the project
+
+```markdown
+config: Update configuration files
+```
+
+`deploy`: Making changes to the deployment process for the project
+
+```markdown
+deploy: Update deployment scripts
+```
+
+`init`: Creating or initializing a new repository or project
+
+```markdown
+init: Initialize project
+```
+
+`move`: Moving files or directories within the project
+
+```markdown
+move: Move files to new directory
+```
+
+`rename`: Renaming files or directories within the project
+
+```markdown
+rename: Rename files
+```
+
+`remove`: Removing files or directories from the project
+
+```markdown
+remove: Remove files
+```
+
+`update`: Updating code, dependencies, or other components of the project
+
+```markdown
+update: Update code
+```
+
+These are just some examples, and you can create your own custom commit types as well. However, it's important to use them consistently and write clear, descriptive commit messages to make it easy for others to understand the changes you've made.
+
+**Important:** If you are planning to use a custom commit message type other than the ones listed above, make sure to add it to this list so that others can understand it as well. Create a pull request to add it to this file.