From b7ef6539c2fe08f12ee0dfc0c62dcfa0a6165a4d Mon Sep 17 00:00:00 2001 From: hyperpolymath Date: Sun, 17 May 2026 01:53:36 +0100 Subject: [PATCH] =?UTF-8?q?chore(Item=2011=20tail):=20resolve=208=20stale?= =?UTF-8?q?=20.md=20(keep=20canonical=20.adoc)=20+=202=20.md=E2=86=92.adoc?= =?UTF-8?q?=20conversions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Day 10 lossy-tail, Day-9-style hybrid resolution: - DELETE_MD: .md was broken/auto-gen scaffold cruft; coherent .adoc retained. - CONVERT: .md was the real doc; faithfully converted to AsciiDoc via pandoc 3.9 (union-merge: any legacy .adoc-only content preserved verbatim). Inbound links repointed .md→.adoc. No content lost. FLAG-class ambiguous pairs intentionally deferred. Co-Authored-By: Claude Opus 4.7 --- bitfuckit/CONTRIBUTING.md | 116 ------------ contractiles/runners/must/README.md | 207 ---------------------- recon-silly-ation/CONTRIBUTING.adoc | 2 +- recon-silly-ation/CONTRIBUTING.md | 116 ------------ recon-silly-ation/MAINTAINERS.adoc | 116 ++++++++++++ recon-silly-ation/MAINTAINERS.md | 103 ----------- recon-silly-ation/docs/TPCF.adoc | 6 +- scaffoldia/CONTRIBUTING.md | 116 ------------ tools/dispatcher/CONTRIBUTING.md | 116 ------------ tools/dispatcher/SECURITY.md | 2 +- tools/hud/CODE_OF_CONDUCT.adoc | 138 +++++++++++++++ tools/hud/CODE_OF_CONDUCT.md | 128 ------------- tools/hud/CONTRIBUTING.md | 116 ------------ tools/reunify/CONTRIBUTING.md | 116 ------------ tools/rsr-certified/CONTRIBUTING.md | 116 ------------ tools/rsr-certified/README.adoc | 2 +- tools/rsr-certified/ROADMAP.adoc | 2 +- tools/rsr-certified/docs/RSR_ALIGNMENT.md | 2 +- 18 files changed, 262 insertions(+), 1258 deletions(-) delete mode 100644 bitfuckit/CONTRIBUTING.md delete mode 100644 contractiles/runners/must/README.md delete mode 100644 recon-silly-ation/CONTRIBUTING.md delete mode 100644 recon-silly-ation/MAINTAINERS.md delete mode 100644 scaffoldia/CONTRIBUTING.md delete mode 100644 tools/dispatcher/CONTRIBUTING.md delete mode 100644 tools/hud/CODE_OF_CONDUCT.md delete mode 100644 tools/hud/CONTRIBUTING.md delete mode 100644 tools/reunify/CONTRIBUTING.md delete mode 100644 tools/rsr-certified/CONTRIBUTING.md diff --git a/bitfuckit/CONTRIBUTING.md b/bitfuckit/CONTRIBUTING.md deleted file mode 100644 index ca9432b..0000000 --- a/bitfuckit/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/reposystem.git -cd reposystem - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create reposystem-dev -toolbox enter reposystem-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -reposystem/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/reposystem/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/reposystem/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/reposystem/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/reposystem/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/contractiles/runners/must/README.md b/contractiles/runners/must/README.md deleted file mode 100644 index 12baae6..0000000 --- a/contractiles/runners/must/README.md +++ /dev/null @@ -1,207 +0,0 @@ -# must - -> Task runner + template engine + project enforcer - -**Version:** 0.1.0 -**License:** MPL-2.0 (PMPL-1.0-or-later preferred) -**Language:** Ada 2022 with SPARK contracts - -## Overview - -`must` is a unified project automation tool that combines: -- **Task Runner**: Execute tasks defined in `mustfile.toml` -- **Template Engine**: Mustache-based code generation -- **Project Enforcer**: Validate project requirements and standards -- **Container Deployer**: Build and deploy via Containerfile - -## Installation - -### From Source - -```bash -# Requires: GNAT 15.2.1+, gprbuild -git clone https://github.com/hyperpolymath/must.git -cd must -gprbuild -P must.gpr -./bin/must --version -``` - -### From Container - -```bash -podman pull ghcr.io/hyperpolymath/must:latest -podman run --rm must --help -``` - -## Quick Start - -### Initialize Project - -```bash -must init -``` - -Creates `mustfile.toml` with default configuration. - -### Run Tasks - -```bash -# List all tasks -must --list - -# Run specific task -must build -must test -``` - -### Apply Templates - -```bash -# Apply all templates -must apply - -# Apply specific template -must apply --template ada_package --var module=MyModule -``` - -### Check Requirements - -```bash -# Check all requirements -must check - -# Auto-fix violations -must fix - -# Check + apply + verify -must enforce -``` - -### Deploy Containers - -```bash -# Build from Containerfile -must deploy - -# Build and push with tag -must deploy --tag v1.0.0 --push -``` - -## Features - -### Memory Safety (SPARK) - -All code uses **bounded strings** with fixed maximum lengths: -- No heap allocations -- Stack-only memory -- Buffer overflow protection -- Zero runtime errors (provable with SPARK) - -### Type Safety - -Explicit bounded string types: -- `Bounded_Path` (4096 bytes) - File paths -- `Bounded_String` (1024 bytes) - General strings -- `Bounded_Command` (8192 bytes) - Shell commands -- `Bounded_Description` (2048 bytes) - Descriptions - -### License Enforcement - -Validates and enforces project licensing standards: -- Check for SPDX headers -- Validate copyright holders -- Enforce Podman over Docker -- Check for trailing whitespace, tabs, line endings - -## Configuration - -### mustfile.toml - -```toml -[project] -name = "my-project" -version = "0.1.0" -license = "MPL-2.0" - -[tasks.build] -description = "Build the project" -commands = ["make build"] - -[tasks.test] -description = "Run tests" -dependencies = ["build"] -commands = ["make test"] - -[templates.ada_package] -source = "templates/package.ads.mustache" -destination = "src/{{module_name}}.ads" - -[requirements] -must_have = ["LICENSE", "README.md"] -must_not_have = ["Makefile", "Dockerfile"] - -[enforcement] -license = "MPL-2.0" -podman_not_docker = true -``` - -## Project Structure - -``` -must/ -├── src/ -│ ├── must.adb # Main entry point -│ ├── must_types.ads/adb # Bounded string types -│ ├── cli/ # CLI argument parsing -│ ├── config/ # TOML configuration -│ ├── tasks/ # Task execution -│ ├── templates/ # Mustache rendering -│ ├── requirements/ # Requirement checking -│ └── deploy/ # Container deployment -├── must.gpr # GNAT project file -└── mustfile.toml # Project configuration -``` - -## Development Status - -**Current Phase:** Alpha (v0.1.0) - -**SPARK Conversion:** ✅ Complete (2026-02-05) -- All 9 modules converted to bounded strings -- Zero compilation errors/warnings -- Memory safety guaranteed -- Ready for formal verification - -**Next Release:** v0.2.0 -- Mustache partials support -- Content requirement checks -- Enhanced TOML variable loading - -## Contributing - -See [SECURITY.md](SECURITY.md) for security policy. - -All contributions must: -- Use bounded strings (no `Unbounded_String`) -- Include SPDX license headers -- Pass all requirement checks -- Compile with zero warnings - -## License - -Mozilla Public License 2.0 (MPL-2.0) - -**Preferred:** PMPL-1.0-or-later (Palimpsest License) -**Required:** MPL-2.0 for GNAT ecosystem compatibility - -## Related Projects - -- **mustfile** (`_pathroot`): Global authority specification -- **nicaug**: Nickel-augmented configuration engine -- **mustorch**: Rust orchestrator for multi-platform deployment - -## Links - -- **Repository:** https://github.com/hyperpolymath/must -- **Container:** ghcr.io/hyperpolymath/must:latest -- **Issues:** https://github.com/hyperpolymath/must/issues diff --git a/recon-silly-ation/CONTRIBUTING.adoc b/recon-silly-ation/CONTRIBUTING.adoc index 9b7f2e1..f83047d 100644 --- a/recon-silly-ation/CONTRIBUTING.adoc +++ b/recon-silly-ation/CONTRIBUTING.adoc @@ -293,7 +293,7 @@ We prioritize *emotional safety* and *reversibility*: * Check link:docs/FAQ.adoc[] (if exists) * Ask in GitHub Discussions -* Contact maintainers: see link:MAINTAINERS.md[] +* Contact maintainers: see link:MAINTAINERS.adoc[] * Read link:CLAUDE.adoc[] for AI assistant context == Thank You! diff --git a/recon-silly-ation/CONTRIBUTING.md b/recon-silly-ation/CONTRIBUTING.md deleted file mode 100644 index ccc0026..0000000 --- a/recon-silly-ation/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/recon-silly-ation.git -cd recon-silly-ation - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create recon-silly-ation-dev -toolbox enter recon-silly-ation-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -recon-silly-ation/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/recon-silly-ation/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/recon-silly-ation/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/recon-silly-ation/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/recon-silly-ation/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/recon-silly-ation/MAINTAINERS.adoc b/recon-silly-ation/MAINTAINERS.adoc index ac120fa..d7943bb 100644 --- a/recon-silly-ation/MAINTAINERS.adoc +++ b/recon-silly-ation/MAINTAINERS.adoc @@ -1,4 +1,120 @@ // SPDX-License-Identifier: PMPL-1.0-or-later + +== Maintainers + +This document lists the maintainers of the recon-silly-ation project and describes the governance model. + +=== Current Maintainers + +==== Project Lead + +* *Hyperpolymath* - @Hyperpolymath +** Role: Project founder, architecture, RSR compliance +** Email: j.d.a.jewell@open.ac.uk +** Timezone: UTC +** Available: Weekdays, asynchronous communication preferred + +=== Maintainer Responsibilities + +Maintainers are responsible for: + +[arabic] +. *Code Review* - Review and merge pull requests +. *Issue Triage* - Label and prioritize issues +. *Release Management* - Version releases and changelogs +. *Security* - Handle security vulnerabilities +. *Community* - Foster welcoming environment +. *Documentation* - Keep docs up-to-date +. *RSR Compliance* - Maintain framework standards +. *TPCF Governance* - Uphold perimeter policies + +=== Governance Model + +==== TPCF Perimeter 3: Community Sandbox + +This project operates under *Tri-Perimeter Contribution Framework (TPCF) Perimeter 3*: + +* *Open Contribution* - All community members can contribute +* *Graduated Trust* - Maintainers review all changes before merge +* *Transparent Process* - All discussions in public (GitHub issues/PRs) +* *Consensus-Based* - Major decisions require maintainer agreement +* *Reversibility* - All changes can be reverted if issues arise + +==== Decision-Making Process + +[arabic] +. *Routine Changes* - Any maintainer can approve and merge +. *Significant Changes* - Requires 2 maintainer approvals +. *Breaking Changes* - Requires all active maintainer approvals +. *Governance Changes* - Requires community discussion {plus} maintainer consensus + +=== Becoming a Maintainer + +We welcome new maintainers! The process: + +[arabic] +. *Contribute Regularly* - Demonstrate sustained engagement (3{plus} months) +. *Show Expertise* - Deep understanding of codebase and architecture +. *Build Trust* - History of helpful reviews and community support +. *Nomination* - Existing maintainer nominates you +. *Consensus* - All maintainers must agree +. *Onboarding* - 1-month shadowing period + +=== Maintainer Expectations + +==== Time Commitment + +* *Minimum*: 2 hours/week for review and triage +* *Releases*: 4 hours/month for release management +* *Communication*: Respond to mentions within 1 week + +==== Skills Required + +* *Technical*: Proficiency in Deno, ReScript, Rust, or Haskell +* *Review*: Ability to provide constructive code review +* *Communication*: Clear, kind, professional communication +* *RSR Knowledge*: Understanding of framework principles + +==== Stepping Down + +Maintainers may step down at any time by: + +[arabic] +. Notifying other maintainers +. Transferring responsibilities +. Updating this document +. (Optional) Transitioning to emeritus status + +=== Emeritus Maintainers + +Former maintainers who remain available for consultation: + +* (None yet - project is young!) + +=== Contact + +* *General Questions*: GitHub Discussions +* *Security Issues*: j.d.a.jewell@open.ac.uk (see SECURITY.md) +* *CoC Violations*: j.d.a.jewell@open.ac.uk (see CODE++_++OF++_++CONDUCT.md) +* *Maintainer Team*: j.d.a.jewell@open.ac.uk + +=== Acknowledgments + +Thank you to all contributors and community members who make this project possible! + +''''' + +*Last Updated*: 2025-11-22 +*RSR Compliance*: Silver Tier Target +*TPCF Perimeter*: 3 (Community Sandbox) + +//// +Appendix preserved verbatim from the legacy .adoc during the +Item 11 .md/.adoc consolidation (Day 10 lossy-tail). 39 legacy-only +content tokens were not present in the converted Markdown source; +retained here so nothing is lost. Reviewer may de-duplicate prose. +//// + = Maintainers :toc: preamble diff --git a/recon-silly-ation/MAINTAINERS.md b/recon-silly-ation/MAINTAINERS.md deleted file mode 100644 index 021d195..0000000 --- a/recon-silly-ation/MAINTAINERS.md +++ /dev/null @@ -1,103 +0,0 @@ -# Maintainers - -This document lists the maintainers of the recon-silly-ation project and describes the governance model. - -## Current Maintainers - -### Project Lead - -* **Hyperpolymath** - @Hyperpolymath - * Role: Project founder, architecture, RSR compliance - * Email: j.d.a.jewell@open.ac.uk - * Timezone: UTC - * Available: Weekdays, asynchronous communication preferred - -## Maintainer Responsibilities - -Maintainers are responsible for: - -1. **Code Review** - Review and merge pull requests -2. **Issue Triage** - Label and prioritize issues -3. **Release Management** - Version releases and changelogs -4. **Security** - Handle security vulnerabilities -5. **Community** - Foster welcoming environment -6. **Documentation** - Keep docs up-to-date -7. **RSR Compliance** - Maintain framework standards -8. **TPCF Governance** - Uphold perimeter policies - -## Governance Model - -### TPCF Perimeter 3: Community Sandbox - -This project operates under **Tri-Perimeter Contribution Framework (TPCF) Perimeter 3**: - -* **Open Contribution** - All community members can contribute -* **Graduated Trust** - Maintainers review all changes before merge -* **Transparent Process** - All discussions in public (GitHub issues/PRs) -* **Consensus-Based** - Major decisions require maintainer agreement -* **Reversibility** - All changes can be reverted if issues arise - -### Decision-Making Process - -1. **Routine Changes** - Any maintainer can approve and merge -2. **Significant Changes** - Requires 2 maintainer approvals -3. **Breaking Changes** - Requires all active maintainer approvals -4. **Governance Changes** - Requires community discussion + maintainer consensus - -## Becoming a Maintainer - -We welcome new maintainers! The process: - -1. **Contribute Regularly** - Demonstrate sustained engagement (3+ months) -2. **Show Expertise** - Deep understanding of codebase and architecture -3. **Build Trust** - History of helpful reviews and community support -4. **Nomination** - Existing maintainer nominates you -5. **Consensus** - All maintainers must agree -6. **Onboarding** - 1-month shadowing period - -## Maintainer Expectations - -### Time Commitment - -* **Minimum**: 2 hours/week for review and triage -* **Releases**: 4 hours/month for release management -* **Communication**: Respond to mentions within 1 week - -### Skills Required - -* **Technical**: Proficiency in Deno, ReScript, Rust, or Haskell -* **Review**: Ability to provide constructive code review -* **Communication**: Clear, kind, professional communication -* **RSR Knowledge**: Understanding of framework principles - -### Stepping Down - -Maintainers may step down at any time by: - -1. Notifying other maintainers -2. Transferring responsibilities -3. Updating this document -4. (Optional) Transitioning to emeritus status - -## Emeritus Maintainers - -Former maintainers who remain available for consultation: - -* (None yet - project is young!) - -## Contact - -* **General Questions**: GitHub Discussions -* **Security Issues**: j.d.a.jewell@open.ac.uk (see SECURITY.md) -* **CoC Violations**: j.d.a.jewell@open.ac.uk (see CODE_OF_CONDUCT.md) -* **Maintainer Team**: j.d.a.jewell@open.ac.uk - -## Acknowledgments - -Thank you to all contributors and community members who make this project possible! - ---- - -**Last Updated**: 2025-11-22 -**RSR Compliance**: Silver Tier Target -**TPCF Perimeter**: 3 (Community Sandbox) diff --git a/recon-silly-ation/docs/TPCF.adoc b/recon-silly-ation/docs/TPCF.adoc index b4431d7..e122f70 100644 --- a/recon-silly-ation/docs/TPCF.adoc +++ b/recon-silly-ation/docs/TPCF.adoc @@ -225,7 +225,7 @@ Automated gates: === Governance -See link:../MAINTAINERS.md[] for: +See link:../MAINTAINERS.adoc[] for: - Current maintainers - Decision-making process - Becoming a maintainer @@ -255,14 +255,14 @@ Potential additions: * link:../CONTRIBUTING.adoc[Contributing Guidelines] * link:../CODE_OF_CONDUCT.md[Code of Conduct] -* link:../MAINTAINERS.md[Maintainers & Governance] +* link:../MAINTAINERS.adoc[Maintainers & Governance] * link:RSR-COMPLIANCE-AUDIT.adoc[RSR Compliance Audit] == Questions? * GitHub Discussions * Email: j.d.a.jewell@open.ac.uk -* See link:../MAINTAINERS.md[Maintainers] +* See link:../MAINTAINERS.adoc[Maintainers] --- diff --git a/scaffoldia/CONTRIBUTING.md b/scaffoldia/CONTRIBUTING.md deleted file mode 100644 index 70fe52f..0000000 --- a/scaffoldia/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/scaffoldia.git -cd scaffoldia - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create scaffoldia-dev -toolbox enter scaffoldia-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -scaffoldia/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/scaffoldia/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/scaffoldia/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/scaffoldia/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/scaffoldia/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/tools/dispatcher/CONTRIBUTING.md b/tools/dispatcher/CONTRIBUTING.md deleted file mode 100644 index ca9432b..0000000 --- a/tools/dispatcher/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/reposystem.git -cd reposystem - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create reposystem-dev -toolbox enter reposystem-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -reposystem/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/reposystem/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/reposystem/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/reposystem/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/reposystem/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/tools/dispatcher/SECURITY.md b/tools/dispatcher/SECURITY.md index fcff452..a38ca8e 100644 --- a/tools/dispatcher/SECURITY.md +++ b/tools/dispatcher/SECURITY.md @@ -373,7 +373,7 @@ When using Reposystem, we recommend: - [Our PGP Public Key]({{PGP_KEY_URL}}) - [Security Advisories](https://github.com/hyperpolymath/reposystem/security/advisories) - [Changelog](CHANGELOG.md) -- [Contributing Guidelines](CONTRIBUTING.md) +- [Contributing Guidelines](CONTRIBUTING.adoc) - [CVE Database](https://cve.mitre.org/) - [CVSS Calculator](https://www.first.org/cvss/calculator/3.1) diff --git a/tools/hud/CODE_OF_CONDUCT.adoc b/tools/hud/CODE_OF_CONDUCT.adoc index 70699bb..a9b6632 100644 --- a/tools/hud/CODE_OF_CONDUCT.adoc +++ b/tools/hud/CODE_OF_CONDUCT.adoc @@ -1,3 +1,141 @@ +== Contributor Covenant Code of Conduct + +=== Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +=== Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, +and learning from the experience +* Focusing on what is best not just for us as individuals, but for the +overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or +advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email +address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a +professional setting + +=== Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +=== Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +=== Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +=== Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +[[1-correction]] +==== 1. Correction + +*Community Impact*: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +*Consequence*: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +[[2-warning]] +==== 2. Warning + +*Community Impact*: A violation through a single incident or series +of actions. + +*Consequence*: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +[[3-temporary-ban]] +==== 3. Temporary Ban + +*Community Impact*: A serious violation of community standards, including +sustained inappropriate behavior. + +*Consequence*: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +[[4-permanent-ban]] +==== 4. Permanent Ban + +*Community Impact*: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +*Consequence*: A permanent ban from any sort of public interaction within +the community. + +=== Attribution + +This Code of Conduct is adapted from the https://www.contributor-covenant.org[Contributor Covenant], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by https://github.com/mozilla/diversity[Mozilla's code of conduct +enforcement ladder]. + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. + +//// +Appendix preserved verbatim from the legacy .adoc during the +Item 11 .md/.adoc consolidation (Day 10 lossy-tail). 16 legacy-only +content tokens were not present in the converted Markdown source; +retained here so nothing is lost. Reviewer may de-duplicate prose. +//// + = Code of Conduct :toc: diff --git a/tools/hud/CODE_OF_CONDUCT.md b/tools/hud/CODE_OF_CONDUCT.md deleted file mode 100644 index 18c9147..0000000 --- a/tools/hud/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,128 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. diff --git a/tools/hud/CONTRIBUTING.md b/tools/hud/CONTRIBUTING.md deleted file mode 100644 index 954efab..0000000 --- a/tools/hud/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/git-hud.git -cd git-hud - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create git-hud-dev -toolbox enter git-hud-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -git-hud/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/git-hud/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/git-hud/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/git-hud/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/git-hud/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/tools/reunify/CONTRIBUTING.md b/tools/reunify/CONTRIBUTING.md deleted file mode 100644 index d4970c1..0000000 --- a/tools/reunify/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/git-reunify.git -cd git-reunify - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create git-reunify-dev -toolbox enter git-reunify-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -git-reunify/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/git-reunify/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/git-reunify/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/git-reunify/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/git-reunify/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/tools/rsr-certified/CONTRIBUTING.md b/tools/rsr-certified/CONTRIBUTING.md deleted file mode 100644 index e3b9be8..0000000 --- a/tools/rsr-certified/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# Clone the repository -git clone https://github.com/hyperpolymath/git-rsr-certified.git -cd git-rsr-certified - -# Using Nix (recommended for reproducibility) -nix develop - -# Or using toolbox/distrobox -toolbox create git-rsr-certified-dev -toolbox enter git-rsr-certified-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite -``` - -### Repository Structure -``` -git-rsr-certified/ -├── src/ # Source code (Perimeter 1-2) -├── lib/ # Library code (Perimeter 1-2) -├── extensions/ # Extensions (Perimeter 2) -├── plugins/ # Plugins (Perimeter 2) -├── tools/ # Tooling (Perimeter 2) -├── docs/ # Documentation (Perimeter 3) -│ ├── architecture/ # ADRs, specs (Perimeter 2) -│ └── proposals/ # RFCs (Perimeter 3) -├── examples/ # Examples (Perimeter 3) -├── spec/ # Spec tests (Perimeter 3) -├── tests/ # Test suite (Perimeter 2-3) -├── .well-known/ # Protocol files (Perimeter 1-3) -├── .github/ # GitHub config (Perimeter 1) -│ ├── ISSUE_TEMPLATE/ -│ └── workflows/ -├── CHANGELOG.md -├── CODE_OF_CONDUCT.md -├── CONTRIBUTING.md # This file -├── GOVERNANCE.md -├── LICENSE -├── MAINTAINERS.md -├── README.adoc -├── SECURITY.md -├── flake.nix # Nix flake (Perimeter 1) -└── Justfile # Task runner (Perimeter 1) -``` - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/git-rsr-certified/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/git-rsr-certified/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/git-rsr-certified/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/git-rsr-certified/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -``` -docs/short-description # Documentation (P3) -test/what-added # Test additions (P3) -feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) -refactor/what-changed # Code improvements (P2) -security/what-fixed # Security fixes (P1-2) -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -``` -(): - -[optional body] - -[optional footer] diff --git a/tools/rsr-certified/README.adoc b/tools/rsr-certified/README.adoc index 431c2bb..8e3a807 100644 --- a/tools/rsr-certified/README.adoc +++ b/tools/rsr-certified/README.adoc @@ -477,7 +477,7 @@ See link:ROADMAP.adoc[ROADMAP.adoc] for the detailed development roadmap. == Contributing -See link:CONTRIBUTING.md[CONTRIBUTING.md] for contribution guidelines. +See link:CONTRIBUTING.adoc[CONTRIBUTING.md] for contribution guidelines. We follow the RSR Tri-Perimeter Contribution Framework: diff --git a/tools/rsr-certified/ROADMAP.adoc b/tools/rsr-certified/ROADMAP.adoc index 7513726..e61469f 100644 --- a/tools/rsr-certified/ROADMAP.adoc +++ b/tools/rsr-certified/ROADMAP.adoc @@ -322,7 +322,7 @@ This roadmap is a living document. To propose changes: 3. Reference any related RSR framework requirements 4. Discuss in the issue before submitting PRs -See link:CONTRIBUTING.md[CONTRIBUTING.md] for contribution guidelines. +See link:CONTRIBUTING.adoc[CONTRIBUTING.md] for contribution guidelines. --- diff --git a/tools/rsr-certified/docs/RSR_ALIGNMENT.md b/tools/rsr-certified/docs/RSR_ALIGNMENT.md index e29ab8a..1f9833a 100644 --- a/tools/rsr-certified/docs/RSR_ALIGNMENT.md +++ b/tools/rsr-certified/docs/RSR_ALIGNMENT.md @@ -204,4 +204,4 @@ We follow the RSR Tri-Perimeter Contribution Framework (TPCF): - 🧠 **Perimeter 2 (Expert)**: New compliance checks, adapters - 🌱 **Perimeter 3 (Community)**: Documentation, tests, proposals -See [CONTRIBUTING.md](../CONTRIBUTING.md) for details. +See [CONTRIBUTING.md](../CONTRIBUTING.adoc) for details.