1.5 KiB
1.5 KiB
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:
- Fork the repository
- Create a new branch for your change:
git checkout -b feature/my-epic-change - Make your changes and commit them:
git commit -m "Add: Epic changes"
-
Push to your fork and add a pull request.
-
(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.)