Skip to content
Arka Platform

Contributor workflow — arka-deck

Audience: developer who wants to contribute to arka-deck (clone, run, test, open a PR, prepare a release).

Contents

Section titled “Contents”
  • cloner-lancer.md — prerequisites, clone, install, first launch, server in dev mode
  • tests.md — test stack (vitest unit, playwright e2e), conventions, fakes, selective execution
  • working-rules.md — working rules for a contributing AI agent: scope, write-set, conventions
  • gitnexus.md — using GitNexus (impact, rename, detect-changes) to navigate the code safely
  • ci-gates.md — blocking CI gates: line-count, architecture boundary, gitleaks, scorecard, SBOM, licenses, public-docs, doc-links
  • release.md — preparing and publishing a release: tarball, signature, GitHub Release, post-release
  • conventions.md — commits, PR, DCO sign-off, branch and file naming conventions

Before the first contribution

Section titled “Before the first contribution”
  1. Read the Apache 2.0 license and the security posture.
  2. Sign the DCO on each commit (git commit -s).
  3. Follow the code of conduct (CODE_OF_CONDUCT.md).

Documentation status

Section titled “Documentation status”

The skeleton is in place. working-rules.md and gitnexus.md carry the contributor-relevant content from the internal AI agent guides, while staying accessible to a human developer. conventions.md consolidates what currently lives in the root CONTRIBUTING.md. Full rewrite during lot P4.