Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
22 lines (15 loc) · 922 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 922 Bytes

Contributing

Thank you for contributing!

We're trying to keep the module up to date and we're adding new features every time. Your contribution help us so much in a lot of ways.

We ask you to keep contributing, and feel free to open as many issues and PR as you need.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Developer commands

  • npm install - Install all dependencies.
  • node --run demo - Start MagicMirror with demo config showcasing module features.
  • node --run download_modules - Download module list manually.
  • node --run lint - Run linting and formatter checks.
  • node --run lint:fix - Fix linting and formatter issues.
  • node --run test - Run linting and formatter checks + Run spelling check.
  • node --run test:spelling - Run spelling check.