diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d2ac2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to this project. + +Okay, so first of all big thanks for taking your time to contribute by either reporting issues or actually making changes for the code. I really apreciate this <3 + +## How Can I Contribute? + +### Reporting Bugs: +- Use the issue tab to report any bugs or to report issues in general +- Give as much info as possible: + - Steps to reproduce + - Expected behavior + - Actual bechvior + - And logs or error messeges. + +### Requesting a feature: + - Open a issue with the feature-request lable + - Cleary explain the problem your feature would solve (Or cleary explain why you want that feature.) + +### Submiting the code: +1. Fork the repository +2. Create a new branch for your change: + ```bash + git checkout -b feature/my-epic-change + ``` +3. Make your changes and commit them: +```bash +git commit -m "Add: Epic changes" +``` +4. Push to your fork and add a pull request. + +5. (Optional) PGP or SSH sign your commits. +This is an optional thing but I would really apreciate it if you signed your commits with either SSH or PGP. + +### Commit Message Conventions: + +Use simple and discrpive commits. (I know that I am not doing that but I am really trying