From ee6b141efa2f2de7c1a4dd5c345486084e11d111 Mon Sep 17 00:00:00 2001 From: Riddick Date: Thu, 25 Jun 2026 14:53:23 +0200 Subject: [PATCH] Update README to reflect the new core constants architecture branch **Details:** - Updated badge links and branch references to point to the `architecture/core-constants-layer` branch. - Adjusted branch purpose and overview to introduce the **Core Constants Layer**, defining structured, static, and namespaced contracts for system-level constraints. - Expanded documentation to include architectural goals, core concepts, and example structures for the constants system. - Added related milestone, pull request, and repository metadata for better visibility into development progress. - This update establishes a unified foundation for managing framework-level invariants, reducing magic values, and promoting scalability within the FireHub Core-Standard framework. --- README.md | 115 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 81 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index a734470..248f4f1 100644 --- a/README.md +++ b/README.md @@ -22,24 +22,24 @@ /> -[![PHPStan](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPStan.yml/badge.svg?branch=develop)](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPStan.yml) -[![PHPUnit](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPUnit.yml/badge.svg?branch=develop)](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPUnit.yml) -[![Codecov](https://codecov.io/gh/The-FireHub-Project/Core-Standard/branch/develop/graph/badge.svg?token=XW2YEONF51)](https://app.codecov.io/gh/The-FireHub-Project/Core-Standard/tree/develop) +[![PHPStan](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPStan.yml/badge.svg?branch=architecture%2Fcore-constants-layer)](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPStan.yml) +[![PHPUnit](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPUnit.yml/badge.svg?branch=architecture%2Fcore-constants-layer)](https://github.com/The-FireHub-Project/Core-Standard/actions/workflows/PHPUnit.yml) +[![Codecov](https://codecov.io/gh/The-FireHub-Project/Core-Standard/branch/architecture%2Fcore-constants-layer/graph/badge.svg?token=XW2YEONF51)](https://app.codecov.io/gh/The-FireHub-Project/Core-Standard/tree/architecture%2Fcore-constants-layer)

- + GitHub last commit (branch) - + GitHub activity (branch) - + GitHub commit difference between two branches

@@ -49,47 +49,94 @@ Standard provides the base classes, kernel, domain layer, and minimal runtime ut --- -## FireHub Icon Development Branch +## FireHub Icon Core Constant Layer – Development Branch -⚠️ **This is the `develop` branch** +⚠️ **This is the `development` branch** - Unstable - APIs may change without notice - Not intended for production use +### Related + +- Milestone: **Development v1** +- Target Release: **v0.0.0** +- Repository: FireHub Core Standard + +### Pull request + +

+ + GitHub pull request title + + GitHub pull request author + + GitHub pull request created + + GitHub pull request comments +

+ +### Milestone + +

+ + GitHub milestone details +

+ ## FireHub Icon Branch Purpose -The `develop` branch is the **primary integration branch** for all ongoing development. +This branch introduces a structured Core Constants Layer within the FireHub Core-Standard framework. It defines how system-level constants (such as numeric boundaries, memory limits, and precision constraints) are organized, namespaced, and exposed across the Core layer. + +The goal is to eliminate scattered magic values and enforce a consistent, discoverable constant system across the framework. + +## FireHub Icon Architectural Goal -It serves as the staging area where: -- Feature branches are merged -- Bug fixes are integrated -- Experimental work is stabilized -- Code is prepared for upcoming releases +To establish a unified and scalable constants architecture inside FireHub\Core\Constant, ensuring: -All **release branches** are created **from `develop`**. +- strict separation between system constants and runtime logic +- clear domain grouping of constants (System, Memory, Numeric, etc.) +- immutability and stateless design for all constant definitions +- predictable and reusable framework-level constraints +- long-term extensibility for Runtime, Adapter, and Capability layers -## Stability Guarantee +This ensures that Core defines system truth in a structured and enforceable way. -❌ No backward compatibility guarantee -❌ APIs may change without notice -❌ Behavior may be incomplete or inconsistent -❌ Breaking changes are expected +## FireHub Icon Core Concept -This branch is intended **only for contributors and advanced testers**. +The Core Constants Layer is a **static, namespaced contract system** that defines immutable framework rules. -## FireHub Icon Composer Usage (Not Recommended) +Key principles: -For internal testing only: +- Constants are grouped by domain responsibility +- Each group is represented by a dedicated final class +- No behavior, only definitions +- No mixing with Value Objects or Exceptions +- Serves as the single source of truth for system-level constraints -```json -{ - "require": { - "the-firehub-project/core-standard": "dev-develop" - } -} +### Example structure + +``` +FireHub\Core\Constant\System\IntegerLimits +FireHub\Core\Constant\Memory\MemoryLimits +FireHub\Core\Constant\Numeric\NumericLimits ``` -⚠️ Never use dev-develop in production. + +This layer represents **framework-level invariants that never change at runtime**. ## FireHub Icon Authors and Contributors @@ -106,4 +153,4 @@ Architecture guidelines, design principles, and ecosystem documentation are avai This software is licensed under the Apache-2.0 License. -For more details, read the full license [here](./LICENSE). +For more details, read the full license [here](./LICENSE). \ No newline at end of file