Skip to content

Renma Quality Profile

The User Manual's authoritative metadata table owns the complete field inventory. This document owns the deterministic quality thresholds and the deeper token-budget decision policy.

renma-quality is Renma's internal quality-profile family. Reports identify the active profile as renma-quality@<Renma package version>, derived from package.json at build time. The source is src/quality-profile.ts. Quality defaults remain fixed except for the explicitly documented Skill body and content-asset thresholds. Repositories may override those values through the corresponding quality.*_token_warning and quality.*_token_high keys. Numeric increases and weakening quality.ci_policy (fail to warn/off, or warn to off) are governed using the stricter mode from the compared revisions. Mode tightening remains visible but does not block solely because of that transition. quality.ci_policy supports off, warn, and fail, and defaults to fail. The User Manual configuration section is the authoritative configuration contract. The internal shape is versioned so effective policy remains centralized rather than scattering constants across rules.

estimated_tokens means Renma's deterministic, model-neutral estimate. Latin words, identifiers, URLs, and paths are lexical units; consecutive CJK text is grouped in two-code-point units; other punctuation is grouped in units of up to three code points. It is not an exact token count for any model. Skill budgets measure Markdown after frontmatter. Content-asset budgets measure the full file.

Contexts, references, profiles, and examples may record a declared human decision and effective limit with top-level token_budget_override and token_budget_rationale metadata. The override must be a positive safe integer greater than the asset kind's stable compatibility validation baseline: Context 4,000, Reference 5,000, Profile 2,000, or Example 2,500. These values validate declarations independently from current repository warning defaults. Optional token_budget_reviewed_at must be a real YYYY-MM-DD date. Renma does not add these fields automatically. When an asset exceeds its default, an agent should first ask whether it can be split along meaningful boundaries without harming coherence or execution order, and split only after the user agrees. An override is appropriate only when the user confirms the long-form asset is intentionally coherent or ordered; it is not a general ignore mechanism. Renma validates the declaration but cannot prove that human review occurred.

When a Skill body threshold is exceeded, the finding exposes measured, warningThreshold, highThreshold, triggeredThreshold, effectiveSeverity, overBy, the deterministic rounded overPercent, policySource, and the source of each threshold. Content-asset findings expose the declared override, whether it affects the effective warning, its compatibility validation baseline, and the corresponding repository and effective warning/High thresholds. This keeps Renma defaults, repository-specific effective policy, the measurement scope, and the triggered comparison visible together.

For a support asset, a valid token_budget_override raises the effective warning floor only when it is greater than the repository warning threshold: effectiveWarning = max(repositoryWarning, override). The effective High threshold is max(repositoryHigh, effectiveWarning), so neither configuration nor an override can make High lower than the approved warning floor. Existing defaultLimit and effectiveLimit detail fields remain available for compatibility; they identify the Renma kind default and effective warning threshold. Invalid metadata never raises either effective threshold, and a valid override suppresses no finding above its effective thresholds. A valid override below the repository warning remains compatible but is a no-op.

Markdown findings can also include up to three largest heading-based review candidates. Renma selects H2 sections beneath a single H1 title when available; otherwise it uses the shallowest useful heading depth. A section runs until the next heading at the same or a shallower depth, so nested headings remain part of their parent. Candidates are ordered by descending estimated size and then source line. They help locate concentrated content; they are not automatic split instructions or semantic classifications. Keep core routing, ordered workflow, constraints, and completion criteria in SKILL.md; use references/, scripts/, assets/, or independently owned contexts/ according to semantic responsibility. Any support-asset split or override change still requires an explicit human decision. When no useful heading structure exists, the finding calls for manual semantic review.

Agent Skills requirements and recommendations

FieldValueUnit and triggerSeveritySourceRationale and false-positive riskDiagnosticReviewedConfigurable later
agentSkills.nameMaxChars64characters; above is invaliderrorAgent Skills specificationPortable identity limitAS-SKILL-INVALID-NAME0.18.0no
agentSkills.descriptionMinChars1characters; below is invaliderrorAgent Skills specificationRequired discovery metadataAS-SKILL-MISSING-DESCRIPTION / AS-SKILL-INVALID-DESCRIPTION0.18.0no
agentSkills.descriptionMaxChars1,024characters; above is invaliderrorAgent Skills specificationPortable hard limitAS-SKILL-DESCRIPTION-TOO-LONG0.18.0no
agentSkills.compatibilityMaxChars500characters; above is invaliderrorAgent Skills specificationKeeps optional environment requirements conciseAS-SKILL-COMPATIBILITY-TOO-LONG0.18.0no
agentSkills.skillBodyRecommendedMaxTokens5,000recommended body tokensportable recommendation only; Renma's default Medium finding begins above its separate 6,400 warningAgent Skills recommendationLarge focused workflows can still be validQUAL-SKILL-TOKEN-BUDGET0.18.0no
agentSkills.skillRecommendedMaxLines500recommended SKILL.md linesdocumented review evidenceAgent Skills recommendationLine count alone does not prove mixed responsibilitynone0.18.0no
agentSkills.recommendedReferenceDepth1resource hop from SKILL.md; Renma accepts one additional index hoplow beyond two static hopsAgent Skills recommendation plus Renma reachability policyAn index may be useful; deep chains are easy to missSUPPORT-DEEP-REFERENCE-CHAIN0.18.0possibly

The Agent Skills body has no prescribed format. Step-by-step instructions, examples, edge cases, short commands, and the optional scripts/, references/, and assets/ directories are valid. See the official specification and description guidance.

Renma workflow and content advisories

FieldValueUnit and triggerSeveritySourceRationale and false-positive riskDiagnosticReviewedConfigurable later
descriptionMinChars0characters; disablednoneRenmaLength does not establish selection clarityQUAL-SHORT-DESCRIPTION removed from default behavior0.18.0possibly
skillTokenWarning6,400estimated_tokens; Markdown body abovemediumRenma repository governance; separate from the portable 5,000 Agent Skills recommendationProgressive-disclosure review; focused workflows may validly exceed itQUAL-SKILL-TOKEN-BUDGET0.32.0quality.skill_token_warning
skillTokenHigh8,000estimated_tokens; Markdown body abovehighRenma repository governanceHigh maintainability evidence, not proof that a split is requiredQUAL-SKILL-TOKEN-BUDGET0.32.0quality.skill_token_high
contentTokenWarning.context6,400estimated_tokens; full file above effective warningmediumRenmaPrefer an agreed semantic split when coherence survives; intentionally coherent or ordered assets may record a declared decisionQUAL-SUPPORT-ASSET-TOKEN-BUDGET0.32.0quality.context_token_warning plus metadata decision
contentTokenHigh.context8,000estimated_tokens; full file above effective HighhighRenmaHigh maintainability evidence does not prove a split is requiredsame0.32.0quality.context_token_high plus metadata decision
contentTokenWarning.reference7,200estimated_tokens; full file above effective warningmediumRenmaDetailed local references may legitimately be longsame0.32.0quality.reference_token_warning plus metadata decision
contentTokenHigh.reference9,000estimated_tokens; full file above effective HighhighRenmaSame false-positive risk at larger scalesame0.32.0quality.reference_token_high plus metadata decision
contentTokenWarning.profile3,200estimated_tokens; full file above effective warningmediumRenmaProfiles should remain reviewable overlayssame0.32.0quality.profile_token_warning plus metadata decision
contentTokenHigh.profile4,000estimated_tokens; full file above effective HighhighRenmaLong focused overlays can still be validsame0.32.0quality.profile_token_high plus metadata decision
contentTokenWarning.example4,800estimated_tokens; full file above effective warningmediumRenmaComplete examples may legitimately be longsame0.32.0quality.example_token_warning plus metadata decision
contentTokenHigh.example6,000estimated_tokens; full file above effective HighhighRenmaComplete end-to-end examples may legitimately be longsame0.32.0quality.example_token_high plus metadata decision
lowHeadingDensityMinTokens400body estimated_tokens, with fewer than 2 headingslowRenmaLong prose can still be intentionally linearQUAL-LOW-HEADING-DENSITY0.18.0possibly
lowHeadingDensityMinHeadings2headingslowRenmaNavigation heuristic onlysame0.18.0possibly

Routing clarity is deterministic evidence, not a description-length check. An explicit selection phrase may appear in the effective Agent Skill description, an Agent's description metadata, or the Markdown body. Common authoring forms include Use when, When to use, Use this Skill ..., Routing, and explicit trigger language. A description that only summarizes output does not satisfy QUAL-MISSING-ROUTING-CLARITY. In ordinary prose, the phrase must be a positive selection or role statement; negative-only guidance and incidental routing, trigger, or mixin nouns do not count. Exact routing-oriented headings remain strong structural evidence.

Verification guidance is detected only in parsed Markdown headings and body text; unrelated frontmatter does not count. Renma recognizes common bounded forms such as Verification, Validation, verify, validate, testing, and expected output or expected result. This advisory detects the presence of static success-checking guidance; it does not judge whether a command is correct or the checks are exhaustive. A test-related noun such as test fixture is not verification guidance, and an instruction not to test, verify, or validate does not count as a positive check. Exact verification-oriented headings remain sufficient structural evidence.

Metadata advisories

FieldValueUnit and triggerSeveritySourceRationale and false-positive riskDiagnosticReviewedConfigurable later
frontmatterMaxLines48lines; abovelowRenmaMetadata should be a compact indexMETA-FRONTMATTER-TOO-LARGE0.18.0possibly
frontmatterMaxChars4,096characters; abovelowRenmaSeparate from Agent Skills validitysame0.18.0possibly
metadataListItemMaxChars256characters per JSON-array or YAML-list element; abovelowRenmaTags and prose routing should be compact; IDs, URLs, and paths are exempt where practicalMETA-LIST-ITEM-TOO-LONG0.18.0possibly

Reuse candidate advisories

DetectorEligibility and evidenceSeveritySourceRationale and false-positive riskDiagnosticReviewedConfigurable later
reusableContextCandidate60 lines or 800 body estimated_tokens; 4 distinct reusable signals; at least one reusable-knowledge signallowRenmaVerification, Examples, Edge Cases, Risks, Do not, Always, Never, and procedure headings do not qualify by themselvesQUAL-SKILL-MIXED-RESPONSIBILITY0.18.0possibly
sharedSupportCandidate80 lines or 1,200 full-file estimated_tokens; 3 reusable headings; 4 reusable phraseslowRenmaPromotion still requires cross-Skill use, duplication, independent lifecycle, or source-of-truth evidenceMAINT-SUPPORT-ASSET-SHARED-CONTEXT-CANDIDATE0.18.0possibly

Repeated-context evidence

FieldDefaultTriggerSeveritySourceFalse-positive controlDiagnosticReviewedConfigurable later
repeatedContext.exactSectionMinTokens40normalized section estimated tokens at or abovemediumRenmacombined with character and file floorsMAINT-REPEATED-SECTION0.18.0possibly
repeatedContext.exactSectionMinChars240normalized section characters at or abovemediumRenmacombined with token and file floorssame0.18.0possibly
repeatedContext.exactSectionMinFiles2files containing the exact sectionmediumRenmarequires maintained duplicationsame0.18.0possibly
repeatedContext.exactCodeMinChars80normalized fenced-code characters at or abovemediumRenmacombined with token and file floorsMAINT-REPEATED-CODE-BLOCK0.18.0possibly
repeatedContext.exactCodeMinTokens10normalized fenced-code estimated tokens at or abovemediumRenmacombined with character and file floorssame0.18.0possibly
repeatedContext.exactCodeMinFiles2files containing the exact blockmediumRenmarequires maintained duplicationsame0.18.0possibly
repeatedContext.headingMinChars24normalized heading characters at or abovelowRenmaexcludes short generic headingsMAINT-REPEATED-HEADING0.18.0possibly
repeatedContext.headingMinTokens3normalized heading estimated tokens at or abovelowRenmaexcludes terse boilerplatesame0.18.0possibly
repeatedContext.headingMinFiles3files containing the same headinglowRenmaheading equality is review evidence onlysame0.18.0possibly
repeatedContext.tokenShingleTokens40estimated tokens in one normalized sequencemediumRenmacommon boilerplate excluded; near duplicates collapsedMAINT-REPEATED-CONTEXT-PATTERN0.18.0possibly
repeatedContext.tokenShingleMinFiles3files containing the sequencemediumRenmarequires broader repeated evidencesame0.18.0possibly
repeatedContext.tokenShingleNearbyLineWindow8source linesn/aRenmacollapses overlapping nearby matches from the same repeated passagesame0.18.0possibly
repeatedContext.tokenShingleMinUniqueTokens12unique estimated-token unitsmediumRenmaexcludes repetitive boilerplate sequencessame0.18.0possibly
repeatedContext.tokenShingleMinUsefulTokens14non-boilerplate estimated-token unitsmediumRenmarequires meaningful lexical evidencesame0.18.0possibly
repeatedContext.tokenShingleMinChars140normalized charactersmediumRenmaexcludes compact coincidental matchessame0.18.0possibly
repeatedContext.findingCap10findings per repeated-context categoryn/aRenmapresentation only; prevents category dominationall repeated-context IDs0.18.0possibly
repeated linksdisabledsame target repeatednoneRenmalinks to the same official source are normalMAINT-REPEATED-LINK removed from default findings0.18.0possibly

Readiness policy

Readiness starts at 100. Specification failures, high or critical security findings, diagnostic errors, unresolved required graph closure, and exact Renma-owned scaffold residue remain blocking even when the numeric score would otherwise pass. Deprecated or archived assets have no existence penalty.

Readiness answers whether a repository passes these gates; it does not require the report to contain zero findings. A ready report may still have actionable, non-blocking findings, warning checks, or warning diagnostics. Markdown labels that case Ready with advisories and labels a clean ready report Ready. These are presentation labels only: the JSON level remains ready, needs_attention, or not_ready, and advisory presence or count adds no score, check, workflow percentage, CI, or exit-code effect. Finding severity and Readiness blocking semantics remain separate dimensions.

The 0.23.0 Skill Discovery checks are visibility-first and have no separate score weight. Partial or not-adopted coverage never subtracts points, and a cycle warning alone never creates a hard failure. Authoritative coverage and declared-route problems reuse existing prepared diagnostics as compact check evidence; those diagnostics are not copied into Readiness diagnostics, so the new checks cannot subtract a second time for the same condition. Existing Readiness penalties and thresholds below are unchanged.

skills.support_integrity is a non-scoring hard gate over explicitly referenced static Skill-support inspection. A failure makes the Readiness level not_ready without subtracting the legacy layout penalty that applied to the removed location-policy check.

FieldDefaultUnit and triggerEffectSourceRationale and false-positive riskRelated check or diagnosticReviewedConfigurable later
readiness.blockingDiagnosticPenalty40points; one or more diagnostic errorssubtract once and fail checkRenmaStructural errors require correction; diagnostic aggregation avoids multiplying one root causediagnostics.errors0.18.0possibly
readiness.unresolvedRequiredGraphPenalty30points; one or more unresolved required edgessubtract once and fail checkRenmaRequired context closure is operationally necessary; optional edges are excludedgraph.unresolved_edges0.18.0possibly
readiness.ownershipMaximumPenalty20points; proportional to unowned assetssubtract 0-20RenmaOwnership supports review, but small or imported repositories may intentionally omit itownership.coverage0.18.0possibly
readiness.emptyInventoryPenalty10points; no cataloged assetssubtract onceRenmaUsually signals a wrong root or incomplete repository; an intentionally empty repository can be validassets.minimum_inventory0.18.0possibly
readiness.scaffoldResiduePenalty20points; one or more exact Renma-owned Skill or Context scaffold markers remainsubtract once and fail checkRenmaGenerated starter prose is not authored content; exact-marker matching keeps the boundary deterministic and narrowassets.scaffold_completeness / QUAL-RENMA-SCAFFOLD-PLACEHOLDER0.32.0possibly
readiness.workflowClarityPenalty10points; workflow clarity warningsubtract onceRenmaMissing routing clarity impairs use; prose phrasing may evade static recognitionworkflow.clarity and related RN-SKILL-* diagnostics0.18.0possibly
readiness.workflowOptionalContextPenalty5points; unusable optional contextsubtract onceRenmaOptional context should resolve but does not block the core workflowworkflow.optional_context0.18.0possibly
readiness.workflowRequiredInputsPenalty5points; required inputs are unclearsubtract onceRenmaReview signal only because some Skills require no external inputsworkflow.required_inputs0.18.0possibly
readiness.workflowCompletionCriteriaPenalty10points; completion criteria are unclearsubtract onceRenmaReview signal only because completion language varies by workflowworkflow.completion_criteria0.18.0possibly
readiness.layoutWarningPenalty5points per warning layout/path checksubtract per checkRenmaKeeps resolvable path and layout debt visible without making one advisory blockinglayout.* / paths.helper_commands0.18.0possibly
readiness.layoutFailurePenalty15points per failing layout/path checksubtract per check and failRenmaStrict layout failures can make repository evidence unusablelayout.* / paths.helper_commands0.18.0possibly
readiness.readyMinimumScore90score; at or above with no failing checkreadyRenmaMaintains a high bar without making subjective advisories blockingReadiness level0.18.0possibly
readiness.needsAttentionMinimumScore70score; belownot_ready; 70-89 is needs_attentionRenmaSeparates accumulated review debt from isolated advisoriesReadiness level0.18.0possibly

Security proximity, scan operations, and presentation

FieldDefaultUnit and triggerEffectSourceRationale and false-positive riskRelated check or diagnosticReviewedConfigurable later
security.precedingLineFastPath2preceding source linessupplements structural guard associationRenmaPreserves nearby-guard detection while headings, paragraphs, and list structure reduce formatting false positivesapplicable SEC-* command diagnostics0.18.0no
scan.defaultMaxFileSizeBytes524,288bytes per discovered filebound reading and hashing workRenma operational defaultProtects scans from unexpectedly large files; larger legitimate files may require existing scan configurationdiscovery diagnostic0.18.0already configurable
scan.defaultMaxDepth16directory levelsbound discovery depthRenma operational defaultPrevents runaway traversal; unusually deep repositories may need existing scan configurationdiscovery diagnostic0.18.0already configurable
scan.defaultConcurrency16concurrent file operationsbound scan concurrencyRenma operational defaultBalances throughput and file-descriptor pressurenone0.18.0already configurable
presentation.markdownReadinessFindingCap50findings in Readiness Markdowntruncate presentation onlyRenmaKeeps human reports readable without changing JSON evidence or scoreReadiness Markdown0.18.0possibly
presentation.topSummaryItemCap10items in compact summariestruncate presentation onlyRenmaAvoids unbounded summaries; reviewers can use full reportsreport summaries0.18.0possibly

Structural guard proximity includes the same constraint or safety section, the same list item, a directly associated paragraph, or a parent Human Approval, Safety, or Constraints heading. The two-line fast path does not cross a Markdown heading or frontmatter boundary, so a guard in an unrelated peer section cannot authorize a later action. Binary snippets are never exposed. Scan operational limits retain their existing public config fields. Only the explicit Skill and governed content warning/High thresholds in the table are repository-configurable; other quality and Readiness thresholds are internal.