diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..cf672b10 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Contributing to AmbientOps + +Thank you for your interest in contributing to AmbientOps. This document +covers the development setup, contribution workflow, and coding +standards for the project. AmbientOps uses a hospital-model +architecture; please familiarise yourself with the component layout in +`README.adoc` before diving in. + +’’’’’ + +## Getting Started + +``` bash +# Clone the repository +git clone https://github.com/hyperpolymath/ambientops.git +cd ambientops + +# Using Guix (recommended for reproducibility) +guix develop + +# Or using toolbox/distrobox +toolbox create ambientops-dev +toolbox enter ambientops-dev +# Install dependencies manually + +# Verify setup +just check # or: cargo check / mix compile / etc. +just test # Run test suite +``` + +### Repository Structure + + ambientops/ + ├── 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.guix # Guix 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/ambientops/labels/good%20first%20issue) + — Simple Perimeter 3 tasks + +- [`help` + `wanted`](https://github.com/hyperpolymath/ambientops/labels/help%20wanted) + — Community help needed + +- [`documentation`](https://github.com/hyperpolymath/ambientops/labels/documentation) + — Docs improvements + +- [`perimeter-3`](https://github.com/hyperpolymath/ambientops/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/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index 40807fe7..00000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,134 +0,0 @@ -== Contributing to AmbientOps - -Thank you for your interest in contributing to AmbientOps. This document -covers the development setup, contribution workflow, and coding -standards for the project. AmbientOps uses a hospital-model -architecture; please familiarise yourself with the component layout in -`+README.adoc+` before diving in. - -''''' - -=== Getting Started - -[source,bash] ----- -# Clone the repository -git clone https://github.com/hyperpolymath/ambientops.git -cd ambientops - -# Using Guix (recommended for reproducibility) -guix develop - -# Or using toolbox/distrobox -toolbox create ambientops-dev -toolbox enter ambientops-dev -# Install dependencies manually - -# Verify setup -just check # or: cargo check / mix compile / etc. -just test # Run test suite ----- - -==== Repository Structure - -.... -ambientops/ -├── 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.guix # Guix 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 link:.github/ISSUE_TEMPLATE/bug_report.md[bug report template] -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 link:ROADMAP.md[roadmap] if available -2. Search existing issues and discussions 3. Consider which perimeter -the feature belongs to - -*When suggesting*: - -Use the link:.github/ISSUE_TEMPLATE/feature_request.md[feature request -template] 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: - -* https://github.com/hyperpolymath/ambientops/labels/good%20first%20issue[`+good first issue+`] -— Simple Perimeter 3 tasks -* https://github.com/hyperpolymath/ambientops/labels/help%20wanted[`+help wanted+`] -— Community help needed -* https://github.com/hyperpolymath/ambientops/labels/documentation[`+documentation+`] -— Docs improvements -* https://github.com/hyperpolymath/ambientops/labels/perimeter-3[`+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 https://www.conventionalcommits.org/[Conventional Commits]: -``` (): - -{empty}[optional body] - -{empty}[optional footer] diff --git a/RSR_OUTLINE.adoc b/RSR_OUTLINE.adoc index e1a986ce..5e349326 100644 --- a/RSR_OUTLINE.adoc +++ b/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/ambulances/disk/.github/workflows/quality.yml b/ambulances/disk/.github/workflows/quality.yml index 60cc60ca..a876f6cc 100644 --- a/ambulances/disk/.github/workflows/quality.yml +++ b/ambulances/disk/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/ambulances/disk/README.adoc b/ambulances/disk/README.adoc index e5167b57..ced325a7 100644 --- a/ambulances/disk/README.adoc +++ b/ambulances/disk/README.adoc @@ -840,7 +840,7 @@ See link:ROADMAP.adoc[ROADMAP.adoc] for the complete roadmap. == Contributing -We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +We welcome contributions! See link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]. Priority areas for v1.0: diff --git a/ambulances/disk/RSR_OUTLINE.adoc b/ambulances/disk/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/ambulances/disk/RSR_OUTLINE.adoc +++ b/ambulances/disk/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/ambulances/performance/.github/workflows/quality.yml b/ambulances/performance/.github/workflows/quality.yml index 60cc60ca..a876f6cc 100644 --- a/ambulances/performance/.github/workflows/quality.yml +++ b/ambulances/performance/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/ambulances/performance/README.adoc b/ambulances/performance/README.adoc index bdb5af82..75bf3406 100644 --- a/ambulances/performance/README.adoc +++ b/ambulances/performance/README.adoc @@ -789,7 +789,7 @@ See link:ROADMAP.adoc[ROADMAP.adoc] for the complete roadmap to v1.2 and beyond. == Contributing -We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +We welcome contributions! See link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]. Priority areas for v1.2: diff --git a/ambulances/security/.github/workflows/quality.yml b/ambulances/security/.github/workflows/quality.yml index 60cc60ca..a876f6cc 100644 --- a/ambulances/security/.github/workflows/quality.yml +++ b/ambulances/security/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/ambulances/security/README.adoc b/ambulances/security/README.adoc index e47f6cf0..9820bbc4 100644 --- a/ambulances/security/README.adoc +++ b/ambulances/security/README.adoc @@ -852,7 +852,7 @@ See link:ROADMAP.adoc[ROADMAP.adoc] for the complete roadmap. == Contributing -We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +We welcome contributions! See link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]. Priority areas for v1.1: diff --git a/broad-spectrum/.github/workflows/quality.yml b/broad-spectrum/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/broad-spectrum/.github/workflows/quality.yml +++ b/broad-spectrum/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/broad-spectrum/RSR_OUTLINE.adoc b/broad-spectrum/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/broad-spectrum/RSR_OUTLINE.adoc +++ b/broad-spectrum/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/cicada/.github/workflows/quality.yml b/cicada/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/cicada/.github/workflows/quality.yml +++ b/cicada/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/cicada/RSR_OUTLINE.adoc b/cicada/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/cicada/RSR_OUTLINE.adoc +++ b/cicada/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/composer/.github/workflows/quality.yml b/composer/.github/workflows/quality.yml index 60cc60ca..b9a12dd6 100644 --- a/composer/.github/workflows/quality.yml +++ b/composer/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/czech-file-knife/.github/workflows/quality.yml b/czech-file-knife/.github/workflows/quality.yml index 81e5df38..a6304c4f 100644 --- a/czech-file-knife/.github/workflows/quality.yml +++ b/czech-file-knife/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/czech-file-knife/RSR_OUTLINE.adoc b/czech-file-knife/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/czech-file-knife/RSR_OUTLINE.adoc +++ b/czech-file-knife/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/czech-file-knife/guix.scm b/czech-file-knife/guix.scm index 3fc9d369..f9142f8a 100644 --- a/czech-file-knife/guix.scm +++ b/czech-file-knife/guix.scm @@ -2,8 +2,8 @@ ;; SPDX-FileCopyrightText: 2025 hyperpolymath ;; ;; Guix package definition for czech-file-knife -;; Build: guix build -f guix.scm -;; Shell: guix shell -D -f guix.scm +;; Build: guix build -f build/guix.scm +;; Shell: guix shell -D -f build/guix.scm (use-modules (guix packages) (guix gexp) diff --git a/emergency-button/.github/workflows/quality.yml b/emergency-button/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/emergency-button/.github/workflows/quality.yml +++ b/emergency-button/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/emergency-button/RSR_OUTLINE.adoc b/emergency-button/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/emergency-button/RSR_OUTLINE.adoc +++ b/emergency-button/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/guix.scm b/guix.scm deleted file mode 100644 index 65ffc2d2..00000000 --- a/guix.scm +++ /dev/null @@ -1,28 +0,0 @@ -;; SPDX-License-Identifier: MPL-2.0 -;; Guix development environment. -;; Usage: guix shell -D -f guix.scm - -(use-modules (guix packages) - (guix build-system gnu) - (guix licenses) - (gnu packages base) - (gnu packages bash) - (gnu packages base) - (gnu packages java) - (gnu packages rust) - (gnu packages cmake) - (gnu packages zig) - (gnu packages golang) - (gnu packages node) - (gnu packages python)) - -(package - (name "ambientops") - (version "0.1.0") - (source #f) - (build-system gnu-build-system) - (inputs (list coreutils bash make openjdk rust cmake zig go node python)) - (synopsis "ambientops") - (description "ambientops — part of the hyperpolymath ecosystem.") - (home-page "https://github.com/hyperpolymath/ambientops") - (license ((@@ (guix licenses) license) "MPL-2.0" "https://github.com/hyperpolymath/palimpsest-license"))) diff --git a/hardware-crash-team/.github/workflows/quality.yml b/hardware-crash-team/.github/workflows/quality.yml index 60cc60ca..b9a12dd6 100644 --- a/hardware-crash-team/.github/workflows/quality.yml +++ b/hardware-crash-team/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/hybrid-automation-router/.github/workflows/quality.yml b/hybrid-automation-router/.github/workflows/quality.yml index 3b9e479f..e1368b26 100644 --- a/hybrid-automation-router/.github/workflows/quality.yml +++ b/hybrid-automation-router/.github/workflows/quality.yml @@ -42,7 +42,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/hybrid-automation-router/CONTRIBUTING.adoc b/hybrid-automation-router/CONTRIBUTING.adoc index dab29bd6..e7d86315 100644 --- a/hybrid-automation-router/CONTRIBUTING.adoc +++ b/hybrid-automation-router/CONTRIBUTING.adoc @@ -1,3 +1,3 @@ == Contributing -See CONTRIBUTING.adoc for full contribution guidelines. +See ../.github/CONTRIBUTING.md for full contribution guidelines. diff --git a/hybrid-automation-router/README.adoc b/hybrid-automation-router/README.adoc index 007044a7..3ff059e9 100644 --- a/hybrid-automation-router/README.adoc +++ b/hybrid-automation-router/README.adoc @@ -301,7 +301,7 @@ mix credo === Contributing -See CONTRIBUTING.adoc for guidelines. +See ../.github/CONTRIBUTING.md for guidelines. === License diff --git a/immutable-linux-auditor/.github/workflows/quality.yml b/immutable-linux-auditor/.github/workflows/quality.yml index 257e5961..c263b06c 100644 --- a/immutable-linux-auditor/.github/workflows/quality.yml +++ b/immutable-linux-auditor/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/monitoring/flare/.github/workflows/quality.yml b/monitoring/flare/.github/workflows/quality.yml index 60cc60ca..a876f6cc 100644 --- a/monitoring/flare/.github/workflows/quality.yml +++ b/monitoring/flare/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/monitoring/observatory/.github/workflows/quality.yml b/monitoring/observatory/.github/workflows/quality.yml index 6c89d430..63e328b5 100644 --- a/monitoring/observatory/.github/workflows/quality.yml +++ b/monitoring/observatory/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/monitoring/systems-observatory/.github/workflows/quality.yml b/monitoring/systems-observatory/.github/workflows/quality.yml index c174fc50..5da9a952 100644 --- a/monitoring/systems-observatory/.github/workflows/quality.yml +++ b/monitoring/systems-observatory/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/nano-aider/.github/workflows/quality.yml b/nano-aider/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/nano-aider/.github/workflows/quality.yml +++ b/nano-aider/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/nerdsafe-restart/.github/workflows/quality.yml b/nerdsafe-restart/.github/workflows/quality.yml index 60cc60ca..b9a12dd6 100644 --- a/nerdsafe-restart/.github/workflows/quality.yml +++ b/nerdsafe-restart/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/network-orchestrator/README.adoc b/network-orchestrator/README.adoc index d5007a38..9ee52836 100644 --- a/network-orchestrator/README.adoc +++ b/network-orchestrator/README.adoc @@ -1447,7 +1447,7 @@ See link:ROADMAP.adoc[ROADMAP.adoc] for detailed milestones. == Contributing -We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +We welcome contributions! See link:../.github/CONTRIBUTING.md[../.github/CONTRIBUTING.md]. Priority areas for v0.2: diff --git a/nick-shells/.github/workflows/quality.yml b/nick-shells/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/nick-shells/.github/workflows/quality.yml +++ b/nick-shells/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/observatory/.github/workflows/quality.yml b/observatory/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/observatory/.github/workflows/quality.yml +++ b/observatory/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/panoptes/.github/workflows/quality.yml b/panoptes/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/panoptes/.github/workflows/quality.yml +++ b/panoptes/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/panoptes/CHANGELOG.adoc b/panoptes/CHANGELOG.adoc index afff361b..b366a840 100644 --- a/panoptes/CHANGELOG.adoc +++ b/panoptes/CHANGELOG.adoc @@ -44,7 +44,7 @@ https://semver.org/spec/v2.0.0.html[Semantic Versioning]. * README.adoc with full usage guide * SECURITY.md with vulnerability reporting process -* CONTRIBUTING.adoc with TPCF guidelines +* ../.github/CONTRIBUTING.md with TPCF guidelines * GOVERNANCE.adoc with project governance model * CODE_OF_CONDUCT.adoc (Contributor Covenant 2.1) * CLAUDE.adoc for AI assistant integration diff --git a/panoptes/CLAUDE.adoc b/panoptes/CLAUDE.adoc index 20196580..310b15a2 100644 --- a/panoptes/CLAUDE.adoc +++ b/panoptes/CLAUDE.adoc @@ -191,7 +191,7 @@ This project maintains RSR Gold compliance: * [x] `LICENSE.txt` (SPDX: MPL-2.0) * [x] `SECURITY.md` * [x] `CODE_OF_CONDUCT.adoc` -* [x] `CONTRIBUTING.adoc` +* [x] `../.github/CONTRIBUTING.md` * [x] `FUNDING.yml` * [x] `GOVERNANCE.adoc` * [x] `MAINTAINERS.md` diff --git a/panoptes/README.adoc b/panoptes/README.adoc index de8e34da..61e243d2 100644 --- a/panoptes/README.adoc +++ b/panoptes/README.adoc @@ -248,7 +248,7 @@ podman exec panoptes-llm ollama list == Contributing -See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines. +See link:../.github/CONTRIBUTING.md[../.github/CONTRIBUTING.md] for guidelines. == License diff --git a/panoptes/REVERSIBILITY.adoc b/panoptes/REVERSIBILITY.adoc index 6b3cb553..b784936f 100644 --- a/panoptes/REVERSIBILITY.adoc +++ b/panoptes/REVERSIBILITY.adoc @@ -164,7 +164,7 @@ just start-engine * README.adoc - Usage documentation * SECURITY.md - Security considerations -* CONTRIBUTING.adoc - Development guidelines +* ../.github/CONTRIBUTING.md - Development guidelines ''''' diff --git a/personal-sysadmin/.github/workflows/quality.yml b/personal-sysadmin/.github/workflows/quality.yml index 691ea9e9..627b9572 100644 --- a/personal-sysadmin/.github/workflows/quality.yml +++ b/personal-sysadmin/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/personal-sysadmin/docs/GITVISOR-DESIGN.adoc b/personal-sysadmin/docs/GITVISOR-DESIGN.adoc index 82fa8359..a7f37a90 100644 --- a/personal-sysadmin/docs/GITVISOR-DESIGN.adoc +++ b/personal-sysadmin/docs/GITVISOR-DESIGN.adoc @@ -403,7 +403,7 @@ When a new repo is created, git-hud automatically: └── diagnostic.yml # Latest scan results │ SECURITY.md # Security policy -CONTRIBUTING.adoc # Contribution guide +../../.github/CONTRIBUTING.md # Contribution guide CODE_OF_CONDUCT.md # Community standards justfile # Task runner Mustfile # Mandatory checks diff --git a/personal-sysadmin/scripts/github-admin/add-community-health.sh b/personal-sysadmin/scripts/github-admin/add-community-health.sh index 9611a255..a7bd596f 100755 --- a/personal-sysadmin/scripts/github-admin/add-community-health.sh +++ b/personal-sysadmin/scripts/github-admin/add-community-health.sh @@ -107,8 +107,8 @@ while read repo; do # Add SECURITY.md if missing add_if_missing "$repo" "SECURITY.md" "$SECURITY_CONTENT" "Add security policy" - # Add CONTRIBUTING.adoc if missing - add_if_missing "$repo" "CONTRIBUTING.adoc" "$CONTRIBUTING_CONTENT" "Add contributing guide" + # Add ../../../.github/CONTRIBUTING.md if missing + add_if_missing "$repo" "../../../.github/CONTRIBUTING.md" "$CONTRIBUTING_CONTENT" "Add contributing guide" # Add CODE_OF_CONDUCT.md if missing add_if_missing "$repo" "CODE_OF_CONDUCT.md" "$CODE_OF_CONDUCT" "Add code of conduct" diff --git a/personal-sysadmin/scripts/github-admin/add-readme-roadmap.sh b/personal-sysadmin/scripts/github-admin/add-readme-roadmap.sh index 33d7f301..d6c4685e 100755 --- a/personal-sysadmin/scripts/github-admin/add-readme-roadmap.sh +++ b/personal-sysadmin/scripts/github-admin/add-readme-roadmap.sh @@ -25,7 +25,7 @@ cd $repo == Contributing -See link:CONTRIBUTING.adoc[Contributing Guide] +See link:../../../.github/CONTRIBUTING.md[Contributing Guide] == License diff --git a/recovery/emergency-room/.github/workflows/quality.yml b/recovery/emergency-room/.github/workflows/quality.yml index 6c89d430..63e328b5 100644 --- a/recovery/emergency-room/.github/workflows/quality.yml +++ b/recovery/emergency-room/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/recovery/freeze-ejector/.github/workflows/quality.yml b/recovery/freeze-ejector/.github/workflows/quality.yml index 60cc60ca..a876f6cc 100644 --- a/recovery/freeze-ejector/.github/workflows/quality.yml +++ b/recovery/freeze-ejector/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/recovery/operating-theatre/.github/workflows/quality.yml b/recovery/operating-theatre/.github/workflows/quality.yml index 257e5961..e9743eff 100644 --- a/recovery/operating-theatre/.github/workflows/quality.yml +++ b/recovery/operating-theatre/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/recovery/operating-theatre/tasks/Justfile b/recovery/operating-theatre/tasks/Justfile index b5c0d3d8..ee329377 100644 --- a/recovery/operating-theatre/tasks/Justfile +++ b/recovery/operating-theatre/tasks/Justfile @@ -112,11 +112,11 @@ check-nickel: # Build with Guix guix-build: - guix build -f guix.scm + guix build -f build/guix.scm # Enter Guix shell guix-shell: - guix shell -D -f guix.scm + guix shell -D -f build/guix.scm # Build with Guix guix-build: diff --git a/slopctl/.github/workflows/quality.yml b/slopctl/.github/workflows/quality.yml index 257e5961..c263b06c 100644 --- a/slopctl/.github/workflows/quality.yml +++ b/slopctl/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/total-recall/.github/workflows/quality.yml b/total-recall/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/total-recall/.github/workflows/quality.yml +++ b/total-recall/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/total-recall/RSR_OUTLINE.adoc b/total-recall/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/total-recall/RSR_OUTLINE.adoc +++ b/total-recall/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/total-update/.github/workflows/quality.yml b/total-update/.github/workflows/quality.yml index 6c89d430..9f220d50 100644 --- a/total-update/.github/workflows/quality.yml +++ b/total-update/.github/workflows/quality.yml @@ -49,7 +49,7 @@ jobs: MISSING="" [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" - [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" + [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../.github/CONTRIBUTING.md" ] && MISSING="$MISSING CONTRIBUTING" if [ -n "$MISSING" ]; then echo "::warning::Missing docs:$MISSING" diff --git a/total-update/RSR_OUTLINE.adoc b/total-update/RSR_OUTLINE.adoc index 63243fd8..2215481b 100644 --- a/total-update/RSR_OUTLINE.adoc +++ b/total-update/RSR_OUTLINE.adoc @@ -35,7 +35,7 @@ git init sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr