Thank you for your interest in contributing to the Distributed Idempotency Key Engine (DIKE).
As a proprietary distributed infrastructure platform, all contributions must adhere to strict code-quality, cryptographic safety, and architectural standards enforced by the repository Codeowners:
- Kushagra Bhardwaj:
@kush05bhardwaj - Mrinal Prakash:
@mrinalprakashfsd
We utilize a Gitflow-derived trunk development model:
- Create an Issue Branch:
- Feature branches:
feat/<issue-number>-<short-description>(e.g.feat/1-project-scaffolding) - Bugfix branches:
fix/<issue-number>-<short-description> - Refactor branches:
refactor/<short-description>
- Feature branches:
- Synchronize with Trunk: Ensure your local branch is rebased on
mainbefore submitting a Pull Request. - Run Quality Gates: Ensure all linting, static analysis, and Vitest suites pass locally before pushing.
All commit messages must follow the Conventional Commits v1.0.0 specification:
<type>(<scope>): <short description in present tense>
[optional body describing technical rationale and architectural impact]
[optional footer referencing issue, e.g. Fixes #1]
feat: A new architectural capability, route, or engine featurefix: A bug fix or race-condition remediationdocs: Documentation modifications or visual diagram updatestest: Addition or refactoring of unit, integration, or k6 stress testsperf: Latency reduction, SIMD acceleration, or memory optimizationrefactor: Code reorganization with zero change to external contractchore: Tooling, dependency maintenance, or CI pipeline modifications
- Language Runtime: Node.js 24 LTS with TypeScript 5+.
- Strict Typing: Compiles under
exactOptionalPropertyTypes,strictNullChecks, andnoUncheckedIndexedAccess. Zero use ofany. - Zero Heavy Unused Dependencies: All dependencies must have proven high throughput and active maintenance.
- Pure State Transitions: The FSM core (
src/core/fsm.ts) and streaming hasher (src/core/hasher.ts) must remain pure and free from hidden I/O side-effects.
- Every new functional capability must include comprehensive test coverage in Vitest.
- State machines and distributed lock components require exhaustive boundary condition tests and race condition simulation harnesses.
- PRs that reduce overall test coverage will not be merged.
- Open your PR against
main. - Link the corresponding GitHub issue in the PR description (e.g.,
Resolves #1). - Mandatory codeowner review: Every PR requires formal review and approval from either
@kush05bhardwajor@mrinalprakashfsdbefore merging.