Skip to content

Update README for clarity and detail on PHARN - #167

Merged
PrzemekGalarowicz merged 1 commit into
mainfrom
PrzemekGalarowicz-patch-1
Aug 23, 2026
Merged

Update README for clarity and detail on PHARN#167
PrzemekGalarowicz merged 1 commit into
mainfrom
PrzemekGalarowicz-patch-1

Conversation

@PrzemekGalarowicz

Copy link
Copy Markdown
Contributor

Revised the README to clarify PHARN's purpose, methodology, and limitations. Updated sections on AI-assisted development, project structure, and commands.

What this changes

A short description of the change and the problem it solves.

Closes #

Type of change

  • feat — new capability (skill / lens / validator / verifier / griller / auditor), command, or rule
  • fix — bug fix
  • docs — docs-only change
  • chore / refactor — tooling or internal restructure, no behavior change

Checklist

  • I read the four trusted docs (pharn/CONSTITUTION.mdpharn/ARCHITECTURE.mdTHREAT-MODEL.mdLIMITS.md) and did not edit them — they are human-only and hook-protected.
  • No constitutional principle (P0–P7) is violated.
  • If this adds a Capability: it has a role: and ships evals (evals/cases/ + evals/expected/), and every enforces rule_id is produced by ≥1 eval case (P1).
  • Findings cite a file-qualified rule_id; no guarantee is claimed without a floor reduction, otherwise it is labeled advisory (P0).
  • CHANGELOG.md updated; SKILLS_VERSION bumped if the released surface changed.

Quality gates

  • npm run check passes locally (every gate package.json's scripts.check chains — the authoritative list).
  • node pharn/floor/validate.mjs . is GREEN.

Notes for the reviewer

Anything the reviewer should look at first — the reviewer reads eval cases before the capability body.

Revised the README to clarify PHARN's purpose, methodology, and limitations. Updated sections on AI-assisted development, project structure, and commands.
@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cf66ad7a-00c3-4595-8e4f-43cf30f3e997


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@PrzemekGalarowicz
PrzemekGalarowicz merged commit c0d76be into main Aug 23, 2026
8 checks passed
@PrzemekGalarowicz
PrzemekGalarowicz deleted the PrzemekGalarowicz-patch-1 branch August 23, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant