Update README for clarity and detail on PHARN - #167
Merged
Conversation
Revised the README to clarify PHARN's purpose, methodology, and limitations. Updated sections on AI-assisted development, project structure, and commands.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 rulefix— bug fixdocs— docs-only changechore/refactor— tooling or internal restructure, no behavior changeChecklist
pharn/CONSTITUTION.md→pharn/ARCHITECTURE.md→THREAT-MODEL.md→LIMITS.md) and did not edit them — they are human-only and hook-protected.role:and ships evals (evals/cases/+evals/expected/), and everyenforcesrule_id is produced by ≥1 eval case (P1).rule_id; no guarantee is claimed without a floor reduction, otherwise it is labeledadvisory(P0).CHANGELOG.mdupdated;SKILLS_VERSIONbumped if the released surface changed.Quality gates
npm run checkpasses locally (every gatepackage.json'sscripts.checkchains — 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.