Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 2.79 KB
Raw

Contributing to the Tuya Zigbee App for Homey

Thank you for taking the time to contribute! We appreciate your support in improving the Tuya Zigbee app and making it more powerful and reliable.

Below are some guidelines to help you make the most effective contributions. These are not hard rules but suggestions to keep things running smoothly. If you have any questions, feel free to reach out.

Make sure you’ve joined the Homey community or checked the Apps Github discussions (https://github.com/JohanBendz/com.tuya.zigbee) for more informal interactions and updates.

Before Submitting a Bug or Feature Request

  • Read the error message thoroughly and ensure you understand it.
  • Search for similar issues in the repository before opening a new one.
  • Ensure Homey, your apps, and development tools are up to date.
  • Make sure the issue lies with the Tuya Zigbee app and not another app or Homey itself.
  • Investigate the issue yourself where possible. I highly encourage capable developers to submit pull requests rather than issues!

For regular support, feel free to contact me via Github (https://github.com/JohanBendz/com.tuya.zigbee/issues).

Creating a Great Bug Report

  • Context: What were you trying to achieve when the issue occurred?
  • Provide detailed steps to reproduce the issue. If possible, isolate the smallest amount of code necessary to recreate the problem.
  • Include any relevant log files, IDs, or screenshots.
  • Detail any troubleshooting steps you have taken, and if possible, suggest a theory or potential fix.

Submitting a Feature Request

  • Current situation: What’s the existing behavior?
  • Why is the current behavior problematic?
  • Include a detailed proposal, or even better, a pull request that demonstrates the solution.
  • Explain the use case: Who needs this feature and why?
  • List any potential issues or caveats with the feature.

Submitting a Pull Request (PR)

  • Keep the changes focused on one issue or feature to avoid unnecessary complexity.
  • When adding support for a device, please stick to one device per PR.
  • Ensure your changes are contained within a single commit.
  • Rebase from the latest master branch to avoid conflicts.
  • Stick to the existing code formatting and structure to maintain consistency.
  • Ensure any changes are covered by tests, and that they pass before submitting the PR.
  • Add documentation for any new functionality or significant changes.

Speeding Up the Review Process

Merging pull requests can take time. Here’s how you can help:

  • Ask fellow developers to review and test your changes.
  • Keep your PR as small and focused as possible.
  • Make sure your changes are well-documented and explain why they’re necessary.