Skip to content
This repository has been archived by the owner on Apr 18, 2022. It is now read-only.

Latest commit

 

History

History
73 lines (43 loc) · 2.19 KB

Contributing.md

File metadata and controls

73 lines (43 loc) · 2.19 KB

Any contribution helps our team and makes Tasmota better for the entire community!

We need:

  • tutorials on using Tasmota features that aren't covered yet
  • guides on wiring and using sensors supported by Tasmota
  • your DIY projects featuring Tasmota
  • new device templates
  • fixing spelling mistakes, broken links and other errors in the Wiki

The information available is still needed for devices in the field (like Shelly 2) and loss of information makes them unusable in case of debugging or fault analysis.

Writing guides

Whenever you feel is a good guide or an article that would help other users just click the New Page icon and write.

Adding devices to the documentation

All new devices should be submitted through the Templates Repository. If you're adding a device with a comprehensive flashing or configuration tutorial you can create a new page in the Wiki and link to it in your template submission.

Editing articles

Warning

You need a GitHub user account to be able to edit!

If you spot an error in an article use the Improve this article link at the top of the page to correct it.

You'll be taken to the GitHub repository page of that file.

Edit file

Click on the edit button (pencil icon). Edit/Add the text you wanted. When finished find the Propose file change button at the bottom and click it.

Propose file change

Next you need to click Create pull request which is GitHub speak for propose changes. Create pull request

In the PR window add a small description of what you did and click Create pull request Create pull request

Now you wait for one of the Tasmota admins to approve your PR.

Congratulations!

You've made a contribution to the Tasmota project making it a better experience for all future users. Thank you!

Rendering Alert tags

Blockquotes > can now look even fancier:

?> =?>

!> = !>

Tip

> [!TIP]

Note

> [!NOTE]

[!EXAMPLE] > [!EXAMPLE]

Warning

> [!WARNING]

[!DANGER] > [!DANGER]

[!DANGER|style:flat] > [!DANGER|style:flat]