Contribute

Steps to contribute

1. Clone repository
2. Pull latest from master (git checkout master; git pull)
3. Create new feature branch from master
4. Make edits
   1. Do not edit MM-DynamicWeather.js file directly, make all edits in TypeScript files
   2. Run tsc in a window terminal in the MMM-DynamicWeather directory.
   3. Copy files over to MagicMirror installation. Folder is under MaggicMirror/modules/MMM-DynamicWeather
   4. Run npm start to run the app or npm start dev to run the app with DevTools opened.
5. Push changes and create pull request
6. Verify code actions run successfully and fix promptly
7. Link to any issues and update interested users
8. Update the following files:
   1. ChangeLog.md
   2. Readme.md
   3. ConfigurationOptions.md
9. Create a new version tag

Notes about this module

• This module is supposed to be heavily configurable, allowing anyone to add their own custom effects or use some default animations for weather. Please continue to support this idea with any change.
• The getDom() and updateDom() have limitations. getDom() will be called when the module needs to be displayed and should return all the html to add to the module. All HTML content should be wrapped inside the parent <div> the wrapper object. updateDom() will redraw the entire content and reset any timers.

Helpful links

Documentation
Forums
TypeScript