Skip to content

docs: add central project source and scope governance#157

Merged
ProfRandom92 merged 4 commits into
mainfrom
codex/add-canonical-project-governance-documentation
May 20, 2026
Merged

docs: add central project source and scope governance#157
ProfRandom92 merged 4 commits into
mainfrom
codex/add-canonical-project-governance-documentation

Conversation

@ProfRandom92

Copy link
Copy Markdown
Owner

Motivation

  • Summary: Add a single canonical project source to codify CompTextv7’s strategic and technical constraints so future PRs are evaluated against a consistent, enforceable scope and research alignment.
  • This codifies the core positioning that “CompTextv7 is the deterministic replay-integrity layer for compressed operational agent traces” and preserves the core research question and research direction text required by project policy.

Description

  • Changed files: added docs/project_source.md, added NON_GOALS.md, and added CONTRIBUTING.md with the required PR checklist and merge/evidence-index guidance; this is documentation-only with no code, fixture, validator, artifact, or workflow changes.
  • The new docs/project_source.md contains the mandated sections including exact preserved lines: the canonical positioning, the core question, and the research direction, plus strategy, RFC process, merge policy, risk register, and one-sentence rule.
  • NON_GOALS.md encodes prohibited expansion paths and includes the hard scope test exactly as required.
  • CONTRIBUTING.md provides the required PR checklist, non-goals checklist, artifact regeneration expectations, determinism and taxonomy rules, RFC requirement, and an evidence-index reminder.
  • This PR does not modify artifacts/evidence_index.json, scripts/generate_evidence_index.py, tests/test_evidence_index.py, validators, fixtures, or any runtime/orchestration code, and does not regenerate artifacts or introduce LLM/embedding/fuzzy behavior.

Testing

  • Testing: ran npm run check which executes layout, typecheck, validate, build, and test; the full test suite completed successfully and npm run check passed.
  • Automated results: pytest ran the repository tests (283 passed) and the npm pipeline tasks completed without error.
  • Risks: the change is documentation-only and low-risk, with the primary risk being reviewer alignment on wording; no runtime, artifact, or CI workflow impact was introduced.
  • Next: land this governance doc PR to stabilize scope; follow-up PRs (e.g., deterministic MCP trace corruption factory) must reference the RFC process when scope is expanded.

Codex Task

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request establishes foundational governance and project documentation by adding CONTRIBUTING.md, NON_GOALS.md, and docs/project_source.md. These documents define the project's core thesis on deterministic replay-integrity, strict scope boundaries, and the RFC process. Review feedback highlights the need for consistent project naming ('CompText V7') according to the style guide and the replacement of informal terminology like 'semantic-vibes' with more technical language. Additionally, suggestions were made to remove specific pull request references to ensure documentation longevity and to reduce content duplication between files.

Comment thread docs/project_source.md Outdated
@@ -0,0 +1,109 @@
# Project Source: CompTextv7

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The project name is inconsistently formatted. The Repository Style Guide and README.md use CompText V7 (with a space and capital V), while this document uses CompTextv7. Please unify the naming across all documentation for consistency.

Suggested change
# Project Source: CompTextv7
# Project Source: CompText V7
References
  1. The project name should be formatted as CompText V7 as specified in the Repository Style Guide. (link)

Comment thread docs/project_source.md Outdated
Comment on lines +31 to +34
## State After PR #155 and PR #156
After PR #155, the existing `mcp_trace_replay` fixture family was hardened via explicit capability-boundary structures, deterministic degraded variants, `failure_label_on_violation` handling, regenerated artifacts, and preserved scope by avoiding runtime/orchestration/LLM/embedding/fuzzy behavior.

After PR #156, a deterministic artifact evidence index was added to map committed evidence artifacts to their generators, evidence categories, fixture-family coverage, manifest alignment, deterministic evaluation status, LLM-free status, and external-API-free status.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Anchoring the project's canonical source documentation to specific pull request numbers (#155, #156) makes the content prone to becoming stale. It is better to describe the current capabilities and architectural state directly without referencing the PR history.

Suggested change
## State After PR #155 and PR #156
After PR #155, the existing `mcp_trace_replay` fixture family was hardened via explicit capability-boundary structures, deterministic degraded variants, `failure_label_on_violation` handling, regenerated artifacts, and preserved scope by avoiding runtime/orchestration/LLM/embedding/fuzzy behavior.
After PR #156, a deterministic artifact evidence index was added to map committed evidence artifacts to their generators, evidence categories, fixture-family coverage, manifest alignment, deterministic evaluation status, LLM-free status, and external-API-free status.
## Current Implementation State
The mcp_trace_replay fixture family is hardened via explicit capability-boundary structures, deterministic degraded variants, and failure_label_on_violation handling. A deterministic artifact evidence index maps committed evidence artifacts to their generators and categories, ensuring LLM-free and external-API-free validation.

Comment thread docs/project_source.md Outdated
Comment on lines +36 to +44
## Non-Goals
CompTextv7 does not pursue:
- runtime agent orchestration
- autonomous runtime tool routing
- probabilistic semantic judging
- LLM judging
- embeddings or vector retrieval layers
- cloud-first observability platforms
- generalized AI governance platform expansion

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This section duplicates the content in NON_GOALS.md. To maintain a single source of truth and prevent divergence, consider referencing the central NON_GOALS.md file instead of listing them again here.

Suggested change
## Non-Goals
CompTextv7 does not pursue:
- runtime agent orchestration
- autonomous runtime tool routing
- probabilistic semantic judging
- LLM judging
- embeddings or vector retrieval layers
- cloud-first observability platforms
- generalized AI governance platform expansion
## Non-Goals
See NON_GOALS.md in the repository root for the full list of prohibited expansion paths and the hard scope test.

Comment thread NON_GOALS.md Outdated

Hard scope test:

“Does this improve deterministic replay-integrity validation for compressed operational traces without adding probabilistic judgment, orchestration behavior, runtime dependency, cloud dependency, semantic-vibes evaluation, or platform expansion?”

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The term semantic-vibes evaluation is informal and lacks the technical precision found in the rest of the project's documentation. Consider using probabilistic semantic evaluation to maintain a professional tone consistent with the mission.

Suggested change
“Does this improve deterministic replay-integrity validation for compressed operational traces without adding probabilistic judgment, orchestration behavior, runtime dependency, cloud dependency, semantic-vibes evaluation, or platform expansion?”
“Does this improve deterministic replay-integrity validation for compressed operational traces without adding probabilistic judgment, orchestration behavior, runtime dependency, cloud dependency, probabilistic semantic evaluation, or platform expansion?”

Comment thread CONTRIBUTING.md Outdated
- tool routing platform behavior
- LLM judging
- embeddings/vector retrieval
- probabilistic semantic-vibes evaluation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The term semantic-vibes is informal. Using probabilistic semantic evaluation would be more consistent with the technical nature of the project and the terminology used in the non-goals checklist.

Suggested change
- probabilistic semantic-vibes evaluation
- probabilistic semantic evaluation

@ProfRandom92 ProfRandom92 merged commit d02a78a into main May 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant