3.8 KiB
Contributing to Freedom Loader
Welcome! Thanks for your interest in Freedom Loader. Your contributions—bug reports, feature ideas, or code improvements—are always appreciated. Every contribution makes Freedom Loader better.
Quick Links
Ways to Contribute
1. Report a Bug
Found a bug or unexpected behavior? Open an issue using the Bug Report template.
Please include:
- Clear description of the bug
- Steps to reproduce
- App version and environment (Windows version, Firefox version if relevant)
- Logs from:
C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\LOGS-YYYY-MM-DD.log(Windows) or~/.local/share/FreedomLoader/logs/(Linux) - Screenshots if applicable
2. Request a Feature
Have an idea to improve Freedom Loader? Open a Feature Request.
Tips:
- Describe the problem it solves
- Explain your proposed solution
- Include use cases and examples
3. Submit Code Changes
Before starting:
- Check existing issues and PRs to avoid duplicates
- For major changes, open an issue first to discuss
- Follow the project's code style and conventions
Process:
- Fork the repository.
- Check out our Developer Guide (DEVELOPMENT.md) to set up your environment.
- Create a feature branch following our branching conventions.
- Make your changes and test thoroughly on Windows and/or Linux.
- Open a Pull Request using the appropriate template.
Code Guidelines:
- Use camelCase for variables and functions
- Comment complex logic
- Keep commits focused and atomic
- Update documentation if needed
- Don't modify version numbers (done during release)
4. Improve Documentation
Documentation improvements are always welcome:
- Fix typos or unclear sections
- Add missing examples
- Update outdated information
- Improve README, wiki, or guides
Small contributions matter—don't hesitate to submit documentation PRs.
Development Setup
Want to write some code? Awesome!
Please read our Developer Guide (DEVELOPMENT.md) for instructions on how to set up your local environment, our project architecture, and our Git branching rules.
Testing
Before submitting a PR, verify:
- Download functionality works (video/audio)
- No errors in application logs
- Any features wasn't break during the development
- Tested on Windows 10/11 and/or any Linux Distribution
Pull Request Review Process
- Submission: Open PR with clear description using the template
- Review: Maintainers review code and provide feedback
- Updates: Address feedback and push updates
- Approval: Once approved, PR will be merged
- Release: Changes included in next release
Response times:
- Bug fixes: Usually reviewed within 2-3 days
- Features: May take longer depending on complexity
- Documentation: Often reviewed quickly
Code of Conduct
Be respectful and constructive in all interactions. We welcome everyone as long as discussions remain polite and productive.
See CODE_OF_CONDUCT.md for details.
Questions?
- Check the FAQ
- Review the Wiki
- Open a Question issue
Credits
Thanks to Zakaria for the website icon design.
Check out his work: IG @designmark_studio
Thank you for contributing to Freedom Loader!