Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 2.8 KB

README.md

File metadata and controls

66 lines (38 loc) · 2.8 KB
Raw

Berry Playground

This repo and the corresponding dicussions have been created to help Tasmota Berry code developers.

Discussions

By creating this repo "Discussions" was also created. Now Berry developers have another place to ask questions, get help, and make contributions as regards Tasmota Berry coding.

https://github.com/tasmota/Berry_playground/discussions

Alternatively you might try

  • Tasmota Reddit - general tasmota questions (but you can try asking Berry questions here)
  • Tasmota Berry Discord - ( this is where Tasmota Berry dev's hang out so limit your use to when you can get no love here)

Contributions

Repo Main Folders

The repo consists of five primary subfolders of contritutions. Within each are folders of contributions each containing a README.md file explaining their content and now to use them.

  • developer-tools - any developer tools that help us to do tasmota berry coding.
  • modules - ready to go modules that can be downloaded and incorporated into an app or driver
  • app - Full blown, complete, ready to go applications
  • drivers - fully functional driver contributions
  • tutorial-code-blocks - tutorial-code-blocks How To's each focusing on a single coding challenge

Downloading

Each README.md file of a contribution (folder) with contain a link so you can download directly the contribution folder without having to clone the whole repo.

Contributing

If you want to make a contribution (i.e. a folder of code) then follow these steps

  1. Start a discussion topic in the dicussions category corresponding to the primary subfolder where you think your contribution will be best placed.
  2. Fork the repo and add your folder under the appropriate primary subfolder (see above)
  3. Make sure your folder adhears to the guide below
  4. Push your fork to your github account
  5. make a post with a link to your fork
  6. Once others have vetted your contribution (via the discussion) create a PR in issues
  7. Have the maintainers merge your PR (THANK YOU!)

Folder Guide

your contributed folder needs to have a README.md file

in the README.md file you need at least

  • a link to download your folder
  • a clear explanation of the files in your contribution and how to use them
  • a link back to the parent README.md file [return](../README.md)

also edit the parent README.md file and add a linke to your README.md

[my contribution](my-contribution-folder/README.md)

Other resources

https://tasmota.github.io/docs/Berry/
https://berry.readthedocs.io/en/latest/