From 3d0c49d3ec8e547624103a7615af385c00bed2a0 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 26 Dec 2025 14:20:45 +0000 Subject: [PATCH] Add README and ROADMAP documentation - README.adoc: Document RSR infrastructure, technology policies, allowed/blocked technologies, and project structure - ROADMAP.adoc: Outline current status (infrastructure only) and planned development phases, noting spec upload pending --- README.adoc | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++ ROADMAP.adoc | 101 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 220 insertions(+) create mode 100644 ROADMAP.adoc diff --git a/README.adoc b/README.adoc index 8b13789..cdb94d9 100644 --- a/README.adoc +++ b/README.adoc @@ -1 +1,120 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later += git-secure +:toc: preamble +:toclevels: 2 +:icons: font +RSR-compliant repository template with security and standards enforcement. + +== Status + +[IMPORTANT] +==== +*Project specification will be uploaded shortly.* + +This repository currently contains infrastructure scaffolding only. +==== + +== Overview + +`git-secure` is a template repository implementing the *Rhodium Standard Repository (RSR)* specification. It provides: + +* CI/CD workflows for policy enforcement +* Multi-forge synchronisation +* Security best practices +* Reproducible build infrastructure + +== Infrastructure Provided + +=== Technology Policy Enforcement + +[cols="1,2"] +|=== +|Workflow |Purpose + +|`rsr-antipattern.yml` +|Blocks TypeScript, Go, npm — enforces ReScript, Deno, Rust + +|`guix-nix-policy.yml` +|Enforces Guix (primary) / Nix (fallback) package management + +|`wellknown-enforcement.yml` +|Validates RFC 9116 security.txt and RSR well-known standards + +|`security-policy.yml` +|Security scanning and policy compliance +|=== + +=== Allowed Technologies + +[cols="1,2,1"] +|=== +|Technology |Use Case |Notes + +|ReScript |Primary application code |Compiles to JS, type-safe +|Deno |Runtime & package management |Replaces Node/npm +|Rust |Performance-critical, systems, WASM |CLI tools, native code +|Gleam |Backend services |BEAM or JS target +|Guile Scheme |Configuration, state files |STATE.scm, META.scm +|Bash/POSIX |Scripts, automation |Keep minimal +|=== + +=== Blocked Technologies + +[cols="1,1"] +|=== +|Blocked |Replacement + +|TypeScript |ReScript +|Node.js/npm |Deno +|Go |Rust +|Python (general) |ReScript/Rust +|=== + +== Multi-Forge Sync + +This repository automatically propagates to multiple forges on push/release via `instant-sync.yml`. + +== Quick Start + +[source,bash] +---- +# Clone +git clone https://github.com/hyperpolymath/git-secure.git +cd git-secure + +# View available tasks +just + +# Run validation +just validate-rsr +---- + +== Project Structure + +---- +git-secure/ +├── .github/ +│ ├── workflows/ # CI/CD enforcement +│ └── ISSUE_TEMPLATE/ # Issue templates +├── .claude/ # AI assistant configuration +├── docs/ # Documentation +├── justfile # Task runner +├── SECURITY.md # Security policy +├── CONTRIBUTING.md # Contribution guide +└── README.adoc # This file +---- + +== Roadmap + +See link:ROADMAP.adoc[ROADMAP.adoc] for development plans. + +== License + +AGPL-3.0-or-later + +== Links + +* link:SECURITY.md[Security Policy] +* link:CONTRIBUTING.md[Contributing Guide] +* link:docs/CITATIONS.adoc[How to Cite] diff --git a/ROADMAP.adoc b/ROADMAP.adoc new file mode 100644 index 0000000..3499454 --- /dev/null +++ b/ROADMAP.adoc @@ -0,0 +1,101 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later += git-secure Roadmap +:toc: +:toclevels: 2 +:icons: font + +Development roadmap for the git-secure project. + +== Current Status + +[NOTE] +==== +*Project specification will be uploaded shortly.* + +The repository currently contains RSR-compliant infrastructure scaffolding. +No application code has been developed yet. +==== + +== What Exists + +=== Infrastructure (Complete) + +* [x] RSR anti-pattern enforcement workflow +* [x] Guix/Nix package policy workflow +* [x] Well-known standards enforcement (RFC 9116) +* [x] Multi-forge instant sync +* [x] Security policy template +* [x] Contributing guidelines +* [x] Justfile task runner template +* [x] GitHub issue templates +* [x] GitLab CI configuration +* [x] CodeQL security scanning +* [x] OSSF Scorecard integration + +=== Documentation (Partial) + +* [x] SECURITY.md (template) +* [x] CONTRIBUTING.md (template) +* [x] CODE_OF_CONDUCT.md +* [x] Citation formats (docs/CITATIONS.adoc) +* [x] README.adoc +* [x] ROADMAP.adoc (this file) + +== Planned Development + +=== Phase 1: Specification + +* [ ] Upload project specification +* [ ] Define core functionality +* [ ] Architecture decision records (ADRs) +* [ ] API design documents + +=== Phase 2: Core Implementation + +* [ ] Primary codebase (language TBD per RSR policy) +* [ ] Unit test suite +* [ ] Integration tests +* [ ] CI/CD pipeline customisation + +=== Phase 3: Documentation & Release + +* [ ] User documentation +* [ ] API reference +* [ ] Example usage +* [ ] Initial release + +== Technology Constraints + +Per RSR policy, implementation will use: + +[cols="1,2"] +|=== +|Category |Allowed Technologies + +|Application Code |ReScript, Rust, Gleam +|Runtime |Deno +|Package Management |Guix (primary), Nix (fallback) +|Configuration |Nickel, Guile Scheme +|Scripting |Bash/POSIX (minimal) +|=== + +== Contributing + +See link:CONTRIBUTING.md[CONTRIBUTING.md] for how to participate. + +Priority areas: + +1. Specification review (once uploaded) +2. Infrastructure improvements +3. Documentation enhancements + +== Version History + +[cols="1,1,2"] +|=== +|Version |Date |Notes + +|0.0.1 +|2025 +|Initial infrastructure scaffolding +|===