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
73 changes: 73 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
== Changelog

All notable changes to `+neural-foundations+` will be documented in this
file.

This file is generated from conventional commits by the
https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml[`+changelog-reusable.yml+`]
workflow (`+hyperpolymath/standards#206+`). Adopt the workflow in this
repo’s CI to keep this file in sync automatically — see
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+templates/cliff.toml+`]
for the canonical config.

The format follows https://keepachangelog.com/en/1.1.0/[Keep a
Changelog]; this project aims to follow
https://semver.org/spec/v2.0.0.html[Semantic Versioning].

=== [Unreleased]

==== Added

* feat(crg): add crg-grade and crg-badge justfile recipes
* feat: add stapeln.toml container definition
* feat: add UX Justfile with doctor, tour, help-me, assail recipes
* feat: deploy UX Manifesto infrastructure
* feat: add CLADE.a2ml — clade taxonomy declaration

==== Fixed

* fix(ci): bump a2ml/k9-validate-action pins to canonical (#57)
* fix(ci): sync hypatia-scan.yml to canonical (#56)
* fix(ci): build Hypatia escript from repo root (estate dogfood drift)
* fix(ci): hypatia-scan.yml – –exit-zero + GITHUB_TOKEN
(hyperpolymath/hypatia#213) (#52)
* fix(ci): rsr-antipattern duplicate heredoc + setup-beam ubuntu24 (#53)
* fix(ci): move secret-scanner Cargo.toml gate from job-level if: to
step-level (#54)
* fix(scorecard): enforce granular permissions and add fuzzing
placeholder
* fix(ci): Resolve workflow-linter self-matching and metadata issues
* fix: SPDX headers (AGPL→PMPL), email, author name
* fix(license): SPDX AGPL-3.0 → PMPL-1.0-or-later in dotfiles

==== Changed

* refactor: migrate 6SCM → 6A2 (.scm → .a2ml format)

==== Documentation

* docs: substantive CRG C annotation (EXPLAINME.adoc)
* docs: add CRG Grade C header to TEST-NEEDS.md
* docs: add TEST-NEEDS.md and PROOF-NEEDS.md from audit
* docs: add EXPLAINME.adoc — prove-it file backing README claims

==== CI

* ci: redistribute concurrency-cancel guard to read-only check workflows
(#59)
* ci(secret-scanner): drop duplicate –fail from trufflehog extra_args
(#51)
* ci: bump actions/upload-artifact SHA to current v4 (#50)
* ci: SHA-pin hyperpolymath validate-actions in dogfood-gate
* ci(antipattern): fix top-level dir + benchmark/lsp filename matching
(#49)

=== Pre-history

Prior commits to this file’s introduction are recorded in git history
but not formally classified into Keep-a-Changelog sections. To backfill,
run `+git cliff -o CHANGELOG.md+` locally using the canonical
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+cliff.toml+`]
— this is one-shot mechanical work.

'''''
67 changes: 0 additions & 67 deletions CHANGELOG.md

This file was deleted.

24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
== Contributor Covenant Code of Conduct

=== Our Pledge

We pledge to make participation a harassment-free experience for
everyone.

=== Our Standards

*Positive behavior:* * Using welcoming language * Being respectful of
differing viewpoints * Accepting constructive criticism * Focusing on
what is best for the community

*Unacceptable behavior:* * Harassment, trolling, or personal attacks *
Publishing private information without permission

=== Enforcement

Report issues to the maintainers. All complaints will be reviewed.

=== Attribution

Adapted from https://www.contributor-covenant.org/[Contributor Covenant]
v2.1.
27 changes: 0 additions & 27 deletions CODE_OF_CONDUCT.md

This file was deleted.

109 changes: 109 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
== Clone the repository

git clone https://github.com/hyperpolymath/neural-foundations.git cd
neural-foundations

== Using Nix (recommended for reproducibility)

nix develop

== Or using toolbox/distrobox

toolbox create neural-foundations-dev toolbox enter
neural-foundations-dev # Install dependencies manually

== Verify setup

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

....

### Repository Structure
....

neural-foundations/ ├── 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/neural-foundations/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/neural-foundations/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/neural-foundations/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/neural-foundations/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]
Loading
Loading