Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.48 KB
Raw

Contributing

Contributions are welcomed! Please report bugs, suggest improvements, and open pull requests. For major improvements, please open an issue first to discuss what you would like to change.

Implementation Flow

Here's the rough order of things that I recommend when adding support for a new device:

  • Implement the sensor (if needed)
  • Implement unit tests for the sensor
  • Implement the device
  • Implement unit tests for the device
  • Modify EcowittPlatform.ts to add the device
  • Implement synthetic tests for the device (must have sample data)
  • Update config.schema.json for additional config properties (if needed)
  • Update the README.md to add the device
  • Open a PR targeting the dev branch

Validation

Before opening a PR, please ensure that all tests and linting succeeds, and that the code builds:

  • npm run test
  • npm run lint
  • npm run build

Dev Resources

ℹ️ Please let me know if there's anything else I can provide to help get your started!