Skip to content

Commit

Permalink
docs: move contribution guidelines to CONTRIBUTING.md and remove usel…
Browse files Browse the repository at this point in the history
…ess 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
  • Loading branch information
UmmItC committed Dec 6, 2024
1 parent 65e5dd1 commit 2d3b5dd
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 33 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/)
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
29 changes: 0 additions & 29 deletions TODO.md

This file was deleted.

0 comments on commit 2d3b5dd

Please sign in to comment.