Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 2.57 KB
Raw

Contributing to TV-Box Support 📺

Welcome! We're excited that you'd like to contribute to TV-Box Support, an open-source platform for smart TV software. Your contributions are essential to making this project better for everyone!

How You Can Contribute 💡

1. Report Bugs 🐞

Encountered an issue or bug? Let us know by opening a GitHub issue. Please include:

  • Steps to reproduce the problem.
  • Expected vs. actual behavior.
  • Screenshots or logs (if applicable).

Clear bug reports help us resolve issues faster.

2. Suggest Fixes 🛠️

If you have a solution or improvement for a bug, submit it through a pull request. Make sure to:

  • Fork and clone the repository: You'll need your own copy of the repo to work on.
  • Create a new branch: Name it like fix/bug-name.
  • Make your changes: Focus on fixing the issue, and include tests if possible.
  • Ensure tests pass: Run all tests before submitting.
  • Submit a pull request: Once you're ready, push to your fork and submit the PR.

3. Request Features 🌟

Got a feature idea that could enhance TV-Box Support? Submit a feature request by opening a GitHub issue and explaining:

  • The problem your feature would solve.
  • How it would benefit users.
  • Any alternatives or related ideas.

We'll discuss your request and determine how it fits with the project goals.

Submitting a Pull Request 🚀

Follow these steps to submit a pull request:

  1. Fork and clone the repository.
  2. Create a branch for your changes: git checkout -b feature/your-feature-name.
  3. Make your changes and keep them focused on one feature or bug fix.
  4. Write tests for any new code or features.
  5. Run tests to make sure everything works as expected.
  6. Commit your changes with a descriptive message.
  7. Push your branch to your fork.
  8. Open a pull request and fill out the template with the details.

Best Practices for Contributions 🎯

  • Follow the project's coding style and ensure your code is readable.
  • Keep changes small and focused.
  • Write clear commit messages (e.g., "Add feature X" or "Fix bug Y").
  • Provide tests for new functionality to ensure it works as intended.
  • Respect the project's Code of Conduct.

Get Involved 🙌

Your contributions don’t have to be limited to code! You can also:

  • Help improve the documentation.
  • Answer questions from the community.
  • Review open pull requests and provide feedback.

Thank you for contributing to TV-Box Support! Together, we can make smart TV software accessible and powerful for everyone.