jpawlowski/hass.tibber_prices
1
0
Fork 0
mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-05-28 18:43:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
hass.tibber_prices/CONTRIBUTING.md
Julian Pawlowski 2e7ccc36c5 docs(CONTRIBUTING): improve clarity and formatting in contribution guidelines 
Refactor the contribution guidelines to enhance readability and consistency in formatting. Adjusted code blocks and list formatting for better visual structure.

Impact: Contributors will find it easier to follow the guidelines when contributing to the project.

---

docs(README): update automation examples for better readability

Reformatted YAML automation examples in the README to improve clarity and consistency. Indentation and structure were adjusted for better understanding.

Impact: Users will have clearer examples for setting up automations with the integration.

---

chore(manifest): streamline manifest file formatting

Consolidated formatting in the manifest file for consistency. Adjusted the codeowners and requirements sections for a cleaner look.

User-Impact: none

---

chore(pyproject): enhance project configuration for better linting and testing

Updated the pyproject.toml file to improve linting configurations and testing options. Added specific rules for ruff and pytest to align with project standards.

User-Impact: none

---

chore(manifest_schema): simplify JSON schema for integration manifest

Refined the manifest schema by consolidating enum definitions for better readability and maintenance.

User-Impact: none

---

chore(prettier): add Prettier configuration for consistent code formatting

Introduced a Prettier configuration file to standardize code formatting across the project, ensuring consistency in style.

User-Impact: none
2026-04-14 15:35:16 +00:00

4.8 KiB
Raw Blame History

Contributing to Tibber Prices Integration

Thank you for your interest in contributing! This document provides guidelines for contributing to this Home Assistant custom integration.

📋 Table of Contents

For detailed developer documentation, see docs/development/.

Note: This project is developed with extensive AI assistance (GitHub Copilot, Claude). If you're also using AI tools, check AGENTS.md for patterns and conventions that ensure consistency.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/hass.tibber_prices.git
cd hass.tibber_prices
  3. Open in DevContainer (recommended):
    • Open in VS Code
    • Click "Reopen in Container" when prompted
    • Or manually: Ctrl+Shift+P → "Dev Containers: Reopen in Container"

See Development Setup for detailed instructions.

Development Process

1. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description

2. Make Changes

  • Follow the Coding Guidelines
  • Keep changes focused and atomic
  • Update documentation if needed

3. Test Your Changes

# Lint and format
./scripts/lint

# Start development environment
./scripts/develop

# Run tests (if available)
pytest tests/

4. Commit Your Changes

We use Conventional Commits format:

<type>(<scope>): <short summary>

<detailed description>

Impact: <user-visible effects>

Types: feat, fix, docs, refactor, chore, test

For full commit-message rules (including release-note skip trailers for internal/unreleased fixes), see:

  • .github/instructions/commit-messages.instructions.md

Important trailers for commits that should NOT appear in release notes:

  • Release-Notes: skip
  • User-Impact: none
  • Released-Bug: no

Example:

git commit -m "feat(sensors): add daily average price sensor

Added new sensor that calculates average price for the entire day.

Impact: Users can now track daily average prices for cost analysis."

See .github/instructions/commit-messages.instructions.md for detailed commit-message guidelines.

Submitting Changes

Pull Request Process

  1. Push your branch to your fork
  2. Create a Pull Request on GitHub with:
    • Clear title describing the change
    • Detailed description with context
    • Reference related issues (Fixes #123)
  3. Wait for review and address feedback

PR Requirements

  • ✅ Code passes ./scripts/lint-check
  • ✅ No breaking changes (or clearly documented)
  • ✅ Translations updated for all languages
  • ✅ Commit messages follow Conventional Commits
  • ✅ Changes tested in Home Assistant

Coding Standards

Code Style

  • Formatter/Linter: Ruff (enforced automatically)
  • Max line length: 120 characters
  • Python version: 3.13+

Always run before committing:

./scripts/lint

Key Patterns

  • Use dt_util from homeassistant.util for all datetime operations
  • Load translations asynchronously at integration setup
  • Enrich price data before exposing to entities
  • Follow Home Assistant entity naming conventions

See Coding Guidelines for complete details.

Documentation

Documentation is organized in two Docusaurus sites:

  • User docs (docs/user/): Installation, configuration, usage guides
    • Markdown files in docs/user/docs/*.md
    • Navigation via docs/user/sidebars.ts
  • Developer docs (docs/developer/): Architecture, patterns, contribution guides
    • Markdown files in docs/developer/docs/*.md
    • Navigation via docs/developer/sidebars.ts

When adding new documentation:

  1. Place file in appropriate docs/*/docs/ directory
  2. Add to corresponding sidebars.ts for navigation
  3. Update translations when changing translations/en.json (update ALL language files)

Reporting Bugs

Report bugs via GitHub Issues.

Great bug reports include:

  • Quick summary and background
  • Steps to reproduce (be specific!)
  • Expected vs. actual behavior
  • Sample code/logs if applicable

Questions?

License

By contributing, you agree that your contributions will be licensed under its MIT License.