Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .envrc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
109 changes: 109 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# 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/):

():

\[optional body\]

\[optional footer\]
4 changes: 2 additions & 2 deletions .machine_readable/contractiles/Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
115 changes: 0 additions & 115 deletions CONTRIBUTING.adoc

This file was deleted.

4 changes: 2 additions & 2 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion RSR_OUTLINE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/accessibility/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
28 changes: 0 additions & 28 deletions guix.scm

This file was deleted.

Loading