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

=== Overview

This repository follows a modular, maintainable architecture designed
for clarity, scalability, and long-term sustainability.

=== Directory Structure

....
.
├── src/ # Source code
├── tests/ # Test suites
├── docs/ # Documentation
├── scripts/ # Utility scripts
├── config/ # Configuration files
├── LICENSE # License file
├── LICENSES/ # Full license texts
└── README.adoc # Project documentation
....

=== Design Principles

* *Separation of Concerns*: Each module has a single responsibility
* *Testability*: Code is written to be easily testable
* *Documentation*: All public APIs are documented
* *Configuration*: Environment-specific settings are externalized

=== Dependencies

* External dependencies are minimized and clearly declared
* Version pinning is used for reproducibility

=== Security Considerations

* Sensitive data is never committed to the repository
* Secrets are managed through environment variables or secure vaults
* Regular dependency audits are performed

=== Maintainability

* Code follows consistent style guidelines
* Pull requests require review and CI checks
* Issues and discussions are tracked transparently

'''''

_Last updated: 2026-07-18_
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

41 changes: 41 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
== Changelog

All notable changes to `+tentacles-agentic-syllabus+` 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: 7-tentacles — standalone repo, CRG Grade B

==== Fixed

* fix(ci): sync hypatia-scan.yml to canonical (413:
env.HOME+Phase-2+SARIF) (#2)

==== Documentation

* docs: add README stub (mark repo as deliberate reservation) (#1)
* docs: add me/ slot and flag README as in-evolution

=== 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.

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

This file was deleted.

52 changes: 52 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
== Contributing to tentacles-agentic-syllabus

Thanks for your interest. This repository follows the Hyperpolymath
estate standards defined in
https://github.com/hyperpolymath/standards[hyperpolymath/standards].

=== Licence

This project is licensed under *MPL-2.0*. By contributing you agree that
your contributions are licensed under the same terms. Every source file
carries an `+SPDX-License-Identifier+` header; keep it when editing, and
add one to any new file.

=== Development environment

A pinned dev shell is provided:

[source,sh]
----
nix develop # toolchain: git
----

Estate policy is Guix primary / Nix fallback; this repo currently ships
the Nix fallback. A `+guix.scm+` is welcome if you prefer the primary
tier.

=== Language policy

The estate restricts which languages may be used. In particular Python,
Go, TypeScript, ReScript, V-lang, Java/Kotlin, Swift and Makefiles are
*not* accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, Gleam,
Elixir, Haskell, Idris2, Agda, Julia and OCaml are. CI enforces this, so
check the policy in `+hyperpolymath/standards+` before introducing a new
language.

=== Documentation format

Docs are AsciiDoc (`+.adoc+`) by default, including `+README.adoc+`. The
GitHub-required community-health files stay Markdown: `+SECURITY.md+`,
`+CONTRIBUTING.md+`, `+CODE_OF_CONDUCT.md+`, `+CHANGELOG.md+`. Do not
add a `+.md+` duplicate of a doc that already exists as `+.adoc+`.

=== Pull requests

[arabic]
. Branch from `+main+` — do not push to `+main+` directly; branch
protection requires review and passing checks.
. Keep the change focused, and explain _why_ in the PR body.
. Make sure governance CI is green. It checks documentation presence,
packaging policy, secrets, licence consistency and workflow security.
. Security issues: follow `+SECURITY.md+` — report privately, never in a
public issue.
50 changes: 0 additions & 50 deletions CONTRIBUTING.md

This file was deleted.

60 changes: 60 additions & 0 deletions GOVERNANCE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
== Governance

=== Overview

This project is governed by the following principles and structures to
ensure transparent, inclusive, and effective decision-making.

=== Roles and Responsibilities

==== Maintainers

Maintainers are responsible for: - Reviewing and merging pull requests -
Managing releases and versioning - Ensuring code quality and standards -
Triaging issues and bug reports - Community engagement and support

==== Contributors

Contributors are expected to: - Follow the code of conduct - Submit
well-documented pull requests - Write tests for new functionality -
Maintain existing tests - Update documentation as needed

=== Decision Making

==== Minor Changes

* Can be made by any maintainer
* Include bug fixes, documentation updates, dependency updates

==== Major Changes

* Require discussion in issues or pull requests
* Include new features, architectural changes, API changes
* Need approval from at least 2 maintainers

==== Breaking Changes

* Require RFC (Request for Comments) process
* Need approval from majority of maintainers
* Must include migration guide

=== Code of Conduct

All participants are expected to follow our Code of Conduct. Violations
can be reported to the maintainers.

=== Communication

* *Issues*: For bug reports and feature requests
* *Discussions*: For questions and general discussion
* *Pull Requests*: For code contributions

=== Licensing

All contributions are made under the terms of the repository’s LICENSE
file. By submitting a pull request, you agree to license your
contributions accordingly.

'''''

_Last updated: 2026-07-18_
Loading
Loading