Skip to content

Latest commit

 

History

History
193 lines (136 loc) · 12 KB

CONTRIBUTING.md

File metadata and controls

193 lines (136 loc) · 12 KB

Contributing to TP-Link Tapo

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the TP-Link Tapo Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Select the appropiate Label (bug, enhancement, help wanted, question, etc).
  • Provide platform versions (windows, linux, Mac), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the Read Me. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for TP-Link Tapo, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the Read Me carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most TP-Link Tapo users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

Setup for Windows environments

  1. Install Python (at least version 3.12):

    winget install --id=Python.Python.3.12 -e

  2. Execute pip3 in the project's root folder to install dependencies:

    pip3 install -r requirements.txt

  3. To register your plugin in Touch Portal, you can either:

    1. Import the plugin as a .tpp file in the usual way. To generate the .tpp file:

      1. Execute this command in the terminal: 
        tppbuild plugin/build.py
      2. Or, in Visual Studio Code, press Ctrl + Shift + B to open the Tasks window and select 'Package plugin'.

    2. Generate the entry.tp manifest file:

      tppsdk plugin/TPLinkTapoPlugin.py

      Once done, store the generated entry.tp file inside the folder %TouchPortalAPPDataFolder%/plugins/TPLinkTapoPlugin/.

  4. Code your modifications, and if you are working in Visual Studio Code, press F5 to launch a debug session.

Notes on Visual Studio Code goodies:

  • The project contains Visual Studio Code launch definitions to support debug sessions. Just press F5 and go! Note that the plugin must already be registered in Touch Portal.
  • Install the Visual Studio Code plugin Tasks (actboy168.tasks) to access the tasks 'Generate entry.tp' and 'Package plugin' from the Status Bar.

Notes about plugin-conf.txt and plugin-conf-debug.txt

These files configure the plugin execution and are used when launching the executable.

%TP_PLUGIN_FOLDER%TPLinkTapoPlugin\\TPLinkTapoPlugin.exe @plugin-conf.txt

In the case of file plugin-conf-debug.txt, the parameters sent mean:

-d : will output 'verbose' logs in debug mode
-l : the name of the .log file (will be stored in %TouchPortalAPPDataFolder%/plugins/TPLinkTapoPlugin/)
-s : the logStream type, if stderr = sys.stderr, stdout = sys.stdout

In any case you will be able to see logs too on TP's Logs tab.

Want to code inside a Dev Container without installing dependencies in your host?

  1. Install the Visual Studio Code plugin Dev Containers (ms-vscode-remote.remote-containers)
  2. Install Docker Desktop (Note for Windows users: Use of WSL-2 is highly recommended)
  3. Open the project on Visual Studio Code, press Ctrl + Shift + B to open the Tasks window and select 'Dev containers: Rebuild and Reopen in Container'

Notes for Windows Users and Dev Containers:

  • GOOD: You won't have to install extra dependencies on your host Windows PC; the environment has been preconfigured for you.
  • BAD: Packaging the plugin will generate the Linux version of it, not the Windows one.

Improving The Documentation

  • Don't forget to update the Read Me file with your changes, specially if you added new features.

Styleguides

Commit Messages

  • We use Conventional Commits guidelines, despite what the commit history may show before the initial release.

Attribution

This guide is based on the contributing-gen. Make your own!