rules: generalize cross-repository rules from tenferro-rs (issue #6) - #11
Merged
Conversation
Adds the repository-neutral rules required by tensor4all-agent-rules#6 and tensor4all-rs#566's shared-rules prerequisite: - common/repository.md: invariant markers (// INVARIANT + #[allow] rationale), API evolution (no try_* escapes, no deprecated shims), output-update naming, file organization, work logs with PR-body link requirement, rule-inventory meta-rule, and the final cross-phase multi-agent audit protocol. - common/performance.md: performance-gated experiment protocol, cache ownership, complexity budget. - common/docs-and-tests.md: doc-example policy (no ignore/no_run, compile_fail only, executable snippet sync, README sync) and the public Result error-documentation gate. - rust/index.md: unsafe code boundary (SAFETY per block), unit test organization, debug/enum hygiene. - rust/performance.md: uninitialized/scratch acquisition (full-overwrite contract), threading principles (repository-owned execution context). - rust/numerical.md: typed-error classification (parity across eager/symbolic paths, phase as a separate axis, source() preservation, remedies). - rules/index.md: descriptions updated for the new sections. All 18 checklist items (14 from #6 + 4 #566 additions) are covered; the existing validate-rules CI gate (index.md links) passes.
17 tasks
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
1 participant
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.
Summary
Generalizes the repository-neutral rules from tenferro-rs
REPOSITORY_RULES.mdinto the shared
rules/, resolving tensor4all-agent-rules#6 and theshared-rules prerequisite required by tensor4all-rs#566.
What is added
// INVARIANT:+#[allow]rationale + false-positive ledger); API Evolution (no
try_*escapes, nodeprecated shims); Output-Update Naming Principle; File Organization;
Work Logs And Design Records (with the PR-body link requirement and the
rule-inventory meta-rule); Final Cross-Phase Multi-Agent Audit protocol.
Ownership; Complexity Budget.
ignore/no_run,compile_failonly for intentional failures, executable snippet sync,README sync mechanism); Public Result Error-Documentation Gate.
// SAFETY:per block);Unit Test Organization; Debug And Enum Hygiene.
(full-overwrite contract); Threading Principles (repository-owned execution
context).
parity with phase as a separate axis,
source()preservation, remedies).All 14 checklist items from #6 plus the 4 additions required by tensor4all-rs
#566 (performance experiment protocol, work-log PR-body link, rule-inventory
meta-rule, final cross-phase audit) are covered. The existing
validate-rulesCI gate (index.md link resolution) passes.
Out of scope
Repository-specific adoption (strided-rs, tenferro-rs, tensor4all-rs trimming
their local rules to references) is tracked per-repo and follows this merge.