From 2d3b5dd29de9766fedf841c9d92d9dcf84c3005f Mon Sep 17 00:00:00 2001 From: UmmIt Date: Fri, 6 Dec 2024 19:01:35 +0800 Subject: [PATCH] docs: move contribution guidelines to CONTRIBUTING.md and remove useless TODO file - Removed the contribution guidelines section from README.md and migrated it to a new CONTRIBUTING.md file. - Deleted TODO.md as this is useless xd --- CONTRIBUTING.md | 11 +++++++++++ README.md | 4 ---- TODO.md | 29 ----------------------------- 3 files changed, 11 insertions(+), 33 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 TODO.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..08d9ab4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +## Contribution Guidelines + +Always welcome both issues and pull requests! When submitting a pull request (PR), please adhere to the Conventional Commits specification. Avoid using vague commit messages such as `update` or `some update`. + +### I want to contribute to the project. How do I get started? + +Basically no rules, i happy to accept any commit or issue. But if you want to contribute to the project, Please just dont commit like telling nothing. Please explain what you did and why you did it :) + +Good commit message is be kind for yourself and others people who want to read it, and also it will be helpful for the future reference. + +For more please refer to the conventional commit. [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) diff --git a/README.md b/README.md index d551d93..ecaf8c9 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,3 @@ The hotkeys for managing your windows and launching tools are configured in the | `ALT_L + TAB` | Switch Windows | | `ALT_L + P` | Launch Color Picker | | `ALT_L + O` | Launch Zoomer | - -### Contribution Guidelines - -Always welcome both issues and pull requests! When submitting a pull request (PR), please adhere to the Conventional Commits specification. Avoid using vague commit messages such as `update` or `some update`. diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 96e5249..0000000 --- a/TODO.md +++ /dev/null @@ -1,29 +0,0 @@ -## Todo - -## In Progress - -### Network Interface -- [ ] Implement `sed` command to dynamically grep the interface names. - -### Sound Input -- [x] Install required packages such as PulseAudio to enable sound functionality for Waybar control. - -### File Manager -- [ ] Add Yazi Configuration - -### Bluetooth -- [x] Move Waybar Bluetooth item to the Swaync panel - -### Wallpaper Management - -- [ ] **Remove Image Files from Repository** - - Delete all image files currently stored in the Git repository to reduce its size and improve performance. - -- [ ] **Implement Python Script for Image Fetching** - - Develop a Python script to fetch images from a cloud storage service. Includes: - - Mega (ensure it provides an API for fetching images) - - Ente Photos (check if it offers an API for this purpose) - - The script should allow users to download the image of their choice. - -- [ ] **Retain Default Wallpaper** - - Keep only one default wallpaper image in the repository. Ensure it is set as the default image for the project.