Skip to content
Closed
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
1 change: 1 addition & 0 deletions .github/workflows/ada.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ on:
branches: [ "main" ]

permissions: read-all
actions: read

jobs:
build:
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/codeql.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ concurrency:


permissions: read-all
actions: read

jobs:
analyze:
Expand All@@ -45,12 +46,12 @@ jobs:
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

- name: Initialize CodeQL
uses: github/codeql-action/init@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v3.28.1
uses: github/codeql-action/init@29b1f65c1f735799893313399435a59f54045865 # v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v3.28.1
uses: github/codeql-action/analyze@29b1f65c1f735799893313399435a59f54045865 # v3
with:
category: "/language:${{ matrix.language }}"
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ on:
types: [created]

permissions: read-all
actions: read

jobs:
build:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/governance.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ concurrency:
cancel-in-progress: true

permissions:
actions: read
contents: read

jobs:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/hypatia-scan.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ concurrency:
cancel-in-progress: true

permissions:
actions: read
contents: read
security-events: write
pull-requests: write
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/instant-sync.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ on:
types: [published]

permissions:
actions: read
contents: read

jobs:
Expand Down
91 changes: 91 additions & 0 deletions .github/workflows/main-estate-audit.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
name: Central Estate CI/CD Audit

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
estate-audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Required Files Gate
uses: hyperpolymath/cicd-suite/actions/required-files-check@main

- name: Code Hygiene Gate
uses: hyperpolymath/cicd-suite/actions/code-hygiene-check@main

- name: Manifest Validation Gate
uses: hyperpolymath/cicd-suite/actions/manifest-check@main

- name: Idris2 ABI Purity Gate
uses: hyperpolymath/cicd-suite/actions/idris2-abi-check@main

- name: Zig Hexadeca API Gate
uses: hyperpolymath/cicd-suite/actions/zig-hexadeca-check@main

- name: Contractile Validation Gate
uses: hyperpolymath/cicd-suite/actions/contractile-validation-check@main

- name: Recipes Set Validation Gate
uses: hyperpolymath/cicd-suite/actions/recipes-set-check@main

- name: Affirmation Document Gate
uses: hyperpolymath/cicd-suite/actions/affirmation-check@main

- name: Academic Referencing Gate
uses: hyperpolymath/cicd-suite/actions/referencing-check@main

- name: Semantic Audit Gate
uses: hyperpolymath/cicd-suite/actions/semantic-audit-check@main

- name: SPDX License Gate
uses: hyperpolymath/cicd-suite/actions/spdx-license-check@main

- name: Proof Runner Gate
uses: hyperpolymath/cicd-suite/actions/proof-runner-check@main

- name: PRAT Testing Gate
uses: hyperpolymath/cicd-suite/actions/prat-check@main

- name: Panic Attack & Pons Gate
uses: hyperpolymath/cicd-suite/actions/custom-tools-check@main

- name: WWW & Well-Known Compliance Gate
uses: hyperpolymath/cicd-suite/actions/www-compliance-check@main

- name: BoJ Cartridge Validation Gate
uses: hyperpolymath/cicd-suite/actions/boj-cartridge-check@main

- name: Formatting Validation Gate
uses: hyperpolymath/cicd-suite/actions/formatting-check@main

- name: Accreditations & Badges Gate
uses: hyperpolymath/cicd-suite/actions/badges-check@main

- name: Metrics Extraction Gate
uses: hyperpolymath/cicd-suite/actions/metrics-check@main

- name: Linguist & Banned Languages Gate
uses: hyperpolymath/cicd-suite/actions/linguist-check@main

- name: Test & Benchmarks Dashboard Gate
uses: hyperpolymath/cicd-suite/actions/tests-benches-check@main

- name: Hosting & Site Status Gate
uses: hyperpolymath/cicd-suite/actions/hosting-check@main

- name: Git-Sea Analytics Gate
uses: hyperpolymath/cicd-suite/actions/gitsea-check@main

- name: Trust & Humans Validation Gate
uses: hyperpolymath/cicd-suite/actions/trust-humans-check@main

- name: Are We UnAPI Gate (Secret Scanning)
uses: hyperpolymath/cicd-suite/actions/secrets-check@main

- name: Reasonably Good Token Validation Gate
uses: hyperpolymath/cicd-suite/actions/vaulted-tokens-check@main
3 changes: 2 additions & 1 deletion .github/workflows/mirror.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,10 @@ on:
workflow_dispatch:

permissions:
actions: read
contents: read

jobs:
mirror:
uses: hyperpolymath/standards/.github/workflows/mirror-reusable.yml@d135b05bfc647d0c0fbfedc7e80f37ea50f49236
uses: hyperpolymath/standards/.github/workflows/mirror-reusable.yml@7fdc2705df74b4e352d2a1cde3e87a5923fdf329
secrets: inherit
1 change: 1 addition & 0 deletions .github/workflows/pages.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ on:
branches: [main, master]
workflow_dispatch:
permissions:
actions: read
contents: read
pages: write
id-token: write
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/push-email-notify.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ name: Push email notification
on:
push: {}
permissions:
actions: read
contents: read
jobs:
notify:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/scorecard.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ on:
branches: [main]

permissions: read-all
actions: read

jobs:
analysis:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/secret-scanner.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ concurrency:
cancel-in-progress: true

permissions:
actions: read
contents: read

jobs:
Expand All@@ -19,5 +20,5 @@ jobs:
contents: read
pull-requests: write
actions: read
uses: hyperpolymath/standards/.github/workflows/secret-scanner-reusable.yml@d135b05bfc647d0c0fbfedc7e80f37ea50f49236
uses: hyperpolymath/standards/.github/workflows/secret-scanner-reusable.yml@7fdc2705df74b4e352d2a1cde3e87a5923fdf329
secrets: inherit
3 changes: 2 additions & 1 deletion .github/workflows/spark-theatre-gate.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,12 @@ on:
branches: [main, master]

permissions:
actions: read
contents: read

jobs:
spark-theatre-gate:
uses: hyperpolymath/standards/.github/workflows/spark-theatre-gate.yml@d135b05bfc647d0c0fbfedc7e80f37ea50f49236
uses: hyperpolymath/standards/.github/workflows/spark-theatre-gate.yml@7fdc2705df74b4e352d2a1cde3e87a5923fdf329
with:
paths: "."
enforce_zero_contract: false
1 change: 1 addition & 0 deletions .github/workflows/workflow-linter.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ on:
- '.github/workflows/**'

permissions: read-all
actions: read

jobs:
lint-workflows:
Expand Down
116 changes: 116 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
# Clone the repository
git clone https://github.com/hyperpolymath/squisher-corpus.git
cd squisher-corpus

# Using Nix (recommended for reproducibility)
nix develop

# Or using toolbox/distrobox
toolbox create squisher-corpus-dev
toolbox enter squisher-corpus-dev
# Install dependencies manually

# Verify setup
just check # or: cargo check / mix compile / etc.
just test # Run test suite
```

### Repository Structure
```
squisher-corpus/
├── 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/squisher-corpus/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/squisher-corpus/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/squisher-corpus/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/squisher-corpus/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/):
```
<type>(<scope>): <description>

[optional body]

[optional footer]
Loading