Skip to content

Latest commit

 

History

21 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NikaSir · GitHub defaults

This repository contains the default community health and engineering-standard files used across public repositories owned by NikaSir.

The current required specialized-panel contract is NIKAS_SPECIALIZED_PANEL_UI_STANDARD.md v2.2 together with docs/NIKAS_PANEL_NAVIGATION_CONTRACT.md v1.2 and its declared companion contracts. .nikas-ui-standard.json pins the reviewed canonical revision in NikaSir/ha-contract-generated-ui; the local checker verifies the mirrored documents, hashes, lifecycle rules and locked connection geometry against that declaration.

Purpose

The goal is to keep contribution, support, security, issue, pull-request, repository and shared UI rules consistent across the project ecosystem while allowing individual repositories to override a default when they need project-specific behavior.

Defaults and shared standards provided

  • NIKAS_REPOSITORY_CONTRACT.md — mirror of the canonical repository contract for factual delivery, data quality, commands, lifecycle and validation evidence. Canonical schema, tooling and adoption registry are maintained in NikaSir/ha-contract-generated-ui; see the contract's adoption sequence.
  • CONTRIBUTING.md — contribution and change-control rules.
  • SECURITY.md — responsible vulnerability reporting.
  • SUPPORT.md — support and diagnostic expectations.
  • CODE_OF_CONDUCT.md — collaboration standards.
  • GOVERNANCE.md — decision-making model.
  • PULL_REQUEST_TEMPLATE.md — pull-request checklist.
  • .github/ISSUE_TEMPLATE/ — structured bug and feature request forms.
  • REPOSITORY_STANDARD.md — common repository structure and publication expectations.
  • SPECIALIZED_PANEL_UI_STANDARD.md — mandatory mobile-first navigation/application-shell contract for integration-owned Home Assistant panels.
  • docs/NIKAS_PANEL_NAVIGATION_CONTRACT.md — canonical route ownership and source-route hand-off rules.
  • docs/NIKAS_PANEL_LIFECYCLE_CONTRACT.md — registration, unavailable-state and recovery requirements.
  • docs/NIKAS_CONNECTION_DECORATION_CONTRACT.md — locked connection-plaque and blue-corner geometry.
  • docs/NIKAS_REFRESH_ACTION_CONTRACT.md — truthful refresh feedback and stable-render behavior.
  • docs/NIKAS_HACS_PUBLICATION_CONTRACT.md — HACS delivery and release identity requirements.
  • docs/NIKAS_ENGINEERING_KNOWLEDGE_BASE.md — reviewed implementation lessons bound to the normative baseline.
  • NIKAS_INTEGRATION_PANEL_TEMPLATE.md — mandatory common shell, visual primitives, geometry and information-presentation template for specialized panels.
  • SPECIALIZED_PANEL_FRONTEND_RELEASE_STANDARD.md — mandatory self-contained production-bundle and cold-load reliability contract for specialized Home Assistant panels.
  • reference/integration-panel-template/ — development-time reference implementation of the shared panel shell and primitives; it is copied/vendored into integration source and must never be a cross-repository runtime dependency.

Repository-specific overrides

A project repository may provide its own file or issue-template directory when its requirements differ from these defaults. Repository-specific rules take precedence only where the shared contract explicitly permits variation.

Engineering principles

  1. Reproducible changes over manual edits.
  2. Small, reviewable commits and pull requests.
  3. No credentials, tokens, private keys, device secrets, or personal data in source control.
  4. Published artifacts are traceable to reviewed source commits; NikaS panel work uses branches, pull requests and main, not GitHub Releases or automatic release tags.
  5. Automation must fail visibly rather than silently accepting invalid state.
  6. Integration-owned Home Assistant panels use the shared NikaS specialized-panel application shell and NikaS Integration Panel Template unless explicitly exempted by architecture decision.
  7. Every specialized production panel loads from one self-contained project-owned JavaScript bundle; previous UI versions are never runtime dependencies.
  8. Shared reference frontend code is a development-time source/reference only; each integration ships an autonomous production bundle.

About

общая инфраструктура и шаблоны

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages