Add: a new Contributing.md file, Update: the readme and license

This commit is contained in:
2025-09-21 20:30:26 +02:00
parent 64d90f92c2
commit a7f19fbb4f
4 changed files with 256 additions and 6 deletions

53
CONTRIBUTING.md Normal file
View File

@@ -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 </3):
Fix: ... for bug fixes
Add: ... for new features
Update: ... for improvements
Docs: ... for documentation changes
#### Example:
```
Add: support for forwarding image attachments
Fix: IRC disconnect issue on TLS connections
```
### License:
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License (You can find the license in the LICENSE file.)