diff --git a/.envrc b/.envrc index ef739ef..ebba6e1 100644 --- a/.envrc +++ b/.envrc @@ -7,8 +7,8 @@ if has asdf; then use asdf fi -# Load Guix shell if guix.scm exists -if has guix && [ -f guix.scm ]; then +# Load Guix shell if build/guix.scm exists +if has guix && [ -f build/guix.scm ]; then use guix fi diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..adc3827 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,109 @@ +# Clone the repository + +git clone + cd +InvestigativeJournalism.jl + +# Using Guix (recommended for reproducibility) + +guix develop + +# Or using toolbox/distrobox + +toolbox create InvestigativeJournalism.jl-dev toolbox enter +InvestigativeJournalism.jl-dev \# Install dependencies manually + +# Verify setup + +just check \# or: cargo check / mix compile / etc. just test \# Run test +suite + + + ### Repository Structure + +InvestigativeJournalism.jl/ ├── 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) ├── +.machine_readable/ \# ALL machine-readable content (Perimeter 1) │ ├── +\*.a2ml \# State files (STATE, META, ECOSYSTEM, etc.) │ ├── +bot_directives/ \# Bot configs │ └── contractiles/ \# Policy contracts +(k9, dust, lust, must, trust) ├── .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 — fallback (Perimeter 1) ├── guix.scm \# Guix package — primary +(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/InvestigativeJournalism.jl/labels/good%20first%20issue) — Simple Perimeter 3 tasks + - [`help wanted`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/labels/help%20wanted) — Community help needed + - [`documentation`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/labels/documentation) — Docs improvements + - [`perimeter-3`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/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/.machine_readable/contractiles/Justfile b/.machine_readable/contractiles/Justfile index 2a2f420..6874854 100644 --- a/.machine_readable/contractiles/Justfile +++ b/.machine_readable/contractiles/Justfile @@ -555,11 +555,11 @@ state-phase: # Enter Guix development shell (primary) guix-shell: - guix shell -D -f guix.scm + guix shell -D -f build/guix.scm # Build with Guix guix-build: - guix build -f guix.scm + guix build -f build/guix.scm # Enter Guix development shell (fallback) guix-shell: diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index 282bd30..0000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,115 +0,0 @@ -== Clone the repository - -git clone -https://github.com/hyperpolymath/InvestigativeJournalism.jl.git cd -InvestigativeJournalism.jl - -== Using Guix (recommended for reproducibility) - -guix develop - -== Or using toolbox/distrobox - -toolbox create InvestigativeJournalism.jl-dev toolbox enter -InvestigativeJournalism.jl-dev # Install dependencies manually - -== Verify setup - -just check # or: cargo check / mix compile / etc. just test # Run test -suite - -.... - -### Repository Structure -.... - -InvestigativeJournalism.jl/ ├── 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) ├── -.machine_readable/ # ALL machine-readable content (Perimeter 1) │ ├── -*.a2ml # State files (STATE, META, ECOSYSTEM, etc.) │ ├── -bot_directives/ # Bot configs │ └── contractiles/ # Policy contracts -(k9, dust, lust, must, trust) ├── .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 — fallback (Perimeter 1) ├── guix.scm # Guix package — primary -(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/InvestigativeJournalism.jl/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/InvestigativeJournalism.jl/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/): -.... - -(): - -{empty}[optional body] - -{empty}[optional footer] diff --git a/Justfile b/Justfile index 2a2f420..6874854 100644 --- a/Justfile +++ b/Justfile @@ -555,11 +555,11 @@ state-phase: # Enter Guix development shell (primary) guix-shell: - guix shell -D -f guix.scm + guix shell -D -f build/guix.scm # Build with Guix guix-build: - guix build -f guix.scm + guix build -f build/guix.scm # Enter Guix development shell (fallback) guix-shell: diff --git a/RSR_OUTLINE.adoc b/RSR_OUTLINE.adoc index 92b0740..306011c 100644 --- a/RSR_OUTLINE.adoc +++ b/RSR_OUTLINE.adoc @@ -37,7 +37,7 @@ git init just init # Enter development environment -guix shell -D -f guix.scm +guix shell -D -f build/guix.scm # Validate compliance just validate-rsr diff --git a/docs/accessibility/README.adoc b/docs/accessibility/README.adoc index de58834..5ce4633 100644 --- a/docs/accessibility/README.adoc +++ b/docs/accessibility/README.adoc @@ -244,7 +244,7 @@ Burble is committed to: * Supporting screen readers and other assistive technologies * Continuous improvement based on user feedback -We welcome contributions to improve accessibility. See our link:../CONTRIBUTING.adoc[Contributing Guide] for details. +We welcome contributions to improve accessibility. See our link:../../.github/CONTRIBUTING.md[Contributing Guide] for details. == Related Documents diff --git a/guix.scm b/guix.scm deleted file mode 100644 index 5dd8193..0000000 --- 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 "investigativejournalism.jl") - (version "0.1.0") - (source #f) - (build-system gnu-build-system) - (inputs (list coreutils bash make openjdk rust cmake zig go node python)) - (synopsis "investigativejournalism.jl") - (description "investigativejournalism.jl — part of the hyperpolymath ecosystem.") - (home-page "https://github.com/hyperpolymath/investigativejournalism.jl") - (license ((@@ (guix licenses) license) "MPL-2.0" "https://github.com/hyperpolymath/palimpsest-license")))