Best practices for contributing to Leafy Energy code samples

Building a strong demo library together

Leafy Energy is designed as a shared demo toolbox. That makes it useful to agree on how we write, document and share code samples.

Style and readability

• Use clear, descriptive function names (for example getCurrentPriceForSite).
• Add short comments, especially around Leafy-specific concepts.
• Avoid unnecessary frameworks in samples; keep them minimal.

Repository structure

• Directory per language (js/, python/, dotnet/).
• Subfolders per scenario (pricing, ev-charging, batteries, retail).
• A README in each folder with explanations and links to these Guide articles.

Peer review and demo checks

• Have someone else test every new sample.
• Verify that samples run in a sandbox tenant without extra setup.
• Document known limitations so demo teams are not surprised.

With these best practices, Leafy Energy becomes a consistent and reliable demo library for energy, home automation and EV charging.