Skip to content

Contribute

We ❀️ contributions! Whether you're fixing a bug, improving docs, or suggesting a cool new feature β€” you're making Social Media Downloader better for everyone. Thank you!


How to Contribute

Follow these steps to get started:

  1. Fork the repository on GitHub
  2. Create a new branch (e.g., fix-typo-in-readme or add-linux-support)
  3. Make your changes (see guidelines below)
  4. Push to your fork
  5. Open a Pull Request (PR) β€” and we’ll review it!

Don’t worry if you’re new to open source β€” we welcome first-time contributors!


Before You Submit a PR

Please ensure your pull request follows these basic guidelines:

Requirement Details
βœ… Clean, linted code Use consistent naming, remove unused code, and keep things neat
βœ… No breaking changes Your changes should not break existing features or flow
βœ… Add helpful comments (if needed) Especially if the logic is complex
❌ Don’t include compiled files No .exe, .bin, .deb, or other binaries in PRs β€” those are built via GitHub Actions

Important

Do not include built artifacts like .exe, binary, or .deb files in your pull request.
All official releases are compiled and published automatically using GitHub Actions.
If you want to improve the build process, feel free to contribute to our workflow instead!


Where You Can Contribute

You don’t have to be a Python guru to help! Here's how you can contribute:

  • Bug Fixes β€” Fix typos, broken code, or unexpected behavior
  • Platform Support β€” Add compatibility for more systems or terminals
  • Documentation β€” Improve setup guides, usage instructions, or examples
  • Features β€” Add new capabilities or CLI improvements
  • Testing β€” Help test on various OSes and report issues

Helpful Docs

Check out these related pages before contributing:

  • Roadmap β€” Check out planed
  • License β€” Know your rights & responsibilities as a contributor

Need Help?

If you're stuck, unsure, or have questions β€” open a Discussion or file an Issue. We're here to support you.

Thanks for helping us grow. Let's build something awesome together!