Skip to content

Latest commit

 

History

43 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤝 Contributing

This Plugin is created by users for users. We welcome all contributions. There are no paid developers. There are only users who have seen a problem and done their best to fix it. This means this Plugin will always need the contributions of users like you. How can you get involved?

For questions or feedback, feel free and please open an issue or contribute with a Pull Request!

Pull requests are very welcome for:

  • Coding: Developers can help by fixing a bug, adding new features, improving integrations.
  • Localization: Translate into your native language. (Add new language files, Submit translation updates.)
  • Skinning: Create custom skins.
  • Testing: Help developers by using the Plugin and testing out all its features. Report any issues you may experience. Remember to explain what you did to trigger the issue, what was the issue and what were you expecting to happen.
  • Helping users: Our support process relies on enthusiastic contributors like you to help others get the most out of this Plugin.
  • Documentation: Wiki pages are the hub for information. Help make our documentation better by writing new content or correcting existing material.
  • Spread the word: Share this Plugin with the world! Tell your friends and family about how this Plugin creates an amazing entertainment experience.

Your contribution is very welcome! Follow these steps:

  1. 🍴 Fork this repository
  2. 🔄 Create a branch for your feature
  3. 💻 Make your changes
  4. ✅ Commit using informational/explanatory messages
  5. 📤 Push to your branch
  6. Test your changes
  7. 🔍 Open a Pull Request

Enjoy and help us improve it today. :)


⚠️ Some general rules we follow

  1. Unix File Types: Please ensure all files use Unix line endings (LF, not CRLF). Our CI/CD pipeline checks for this.
  2. Code Style & Formatting:
    • Use ruff for linting (rules: E, F, W with exceptions W191 and E501)
    • Use autopep8for code formatting
    • Keep code readable: use descriptive variable and function names

✅ Before You Submit Your Pull Request

Testing is mandatory:

  • Test your changes locally before committing
  • Verify that your code:
    • ✅ Runs without errors
    • ✅ Passes ruff linting checks
    • ✅ Passes autopep8 formatting checks
    • ✅ Doesn't break existing features
    • ✅ Follows the coding style of this project
  • For GUI changes: test on an actual receiver or emulator if possible
  • Include test cases or reproduction steps in your Pull Request description

Commit before pull request:

# 1. Format your code
ruff check --select E,F,W --ignore W191,E501 .

# 2. Verify everything works
# ... manual testing ...

# 3. Commit with clear message
git add .
git commit -m "descriptive commit message"

# 4. Push and create Pull Request
git push

🤖 AI Policy

"AI" herein refers to generative AI tools like large language models (LLMs) that can generate, edit, and review software code, create and manipulate images, or generate human-like communication.

💂‍♂️ Responsibility

  • You are responsible for any code you submit, regardless of whether it was manually written or generated by AI.
  • You must understand and be able to explain the code you submit as well as the existing related code.
  • In explaining your contribution, do not use AI to automatically generate descriptions.
  • You must disclose whether AI has been used to assist in the development of your pull request.
  • Test your code as best you can BEFORE submitting your code. Please ensure that the code you are contibuting works as you expect and that the changes do not break features outside of the code you are changing.

📈 Code Quality

  • Contributors are expected to submit code that meets projects standards and coding style.
  • We will reject pull requests that we deem being "AI slop".
  • Do not waste developers' time by submitting code that is fully or mostly generated by AI, and doesn't meet our standards.
  • Test your code as best you can BEFORE submitting your code. Please ensure that the code you are contibuting works as you expect and that the changes do not break features outside of the code you are changing.

©️ Copyright

  • Contributors license their code under the same license when it is included into version control repository. That means contributors must own the copyright of any code submitted.
  • Code generated by AI may infringe on copyright and it is the submitter's responsibility to not infringe. We reserve the right to reject any pull requests, AI generated or not, where the copyright is in question.
  • Do not remove code attributions from code that you may use in your submission.

📞 Communication

  • When interacting with developers (forum, discussions, issues, pull requests, etc.) do not use AI to speak for you.
  • Human-to-human communication is essential for an open source community to thrive.
  • If you are contributing code taken from other open source developers then please consider alerting those developers should you find any issues in their code.

✨ AI Agents

  • The use of an AI agent that writes code and then submits a pull request autonomously is not permitted.
  • A human must check any generated code and submit a pull request according to the 'Responsibility' section above.

Last Modified: 2026-05-23

About

No description, website, or topics provided.

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages