telegram-s3-uploader/CONTRIBUTING.md

54 lines
1.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Contributing
Contributions are welcome 🙂
If you have an idea, improvement, or bug fix, feel free to jump in.
---
## How to contribute
1. Fork the repository
2. Create a branch for your change
3. Make your changes
4. Open a pull request
Thats all.
---
## A few guidelines
- Keep changes small and focused
- Follow the existing code style where possible
- Dont commit secrets or credentials
- Test your changes before opening a PR
- Keep features within the scope of **private file upload and backup**
---
## Project scope
This project is meant for:
- Personal backups
- Private file storage
- Archiving Telegram content you own or manage
PRs that go beyond this projects scope may be declined to keep things simple and focused.
---
## Ideas to work on
These are possible future improvements, not a fixed roadmap:
- Channel backup support
- Streaming uploads (no local disk)
- File deduplication
- Simple admin commands
- Better logging or error handling
---
Thanks for taking the time to contribute!