diff --git a/README.md b/README.md index 5fe1a88..e959c44 100644 --- a/README.md +++ b/README.md @@ -218,19 +218,13 @@ tests/ # Test projects docs/ └── rules/ # One document per diagnostic, target of the help links -decisions/ # Architecture Decision Records (ADRs) -templates/ # Documentation templates (READMEs, ADR) +templates/ # Documentation templates (READMEs) .github/workflows/ # CI, publishing and maintenance workflows ``` ## Architecture -The two decisions that define the shape of this repository are recorded as ADRs: - -- [Two-pass mutation analysis](decisions/2026-07-31-two-pass-mutation-analysis.md) — why the analysis is split across the test and production compilations, and why a manifest is the artifact between them. -- [Pluggable test framework support](decisions/2026-07-31-pluggable-test-framework-support.md) — how probes and recognisers keep support for additional test frameworks additive, why the unit of the seam is a framework _version_ rather than a framework, and what adding the next one costs: three small files and one registry line. - -Beyond those, two principles run through the code and are worth knowing before changing anything: +Two principles run through the code and are worth knowing before changing anything: - **Errors have a preferred direction.** A false "not trivial" verdict or a false "viable mutant" costs a diagnostic a reviewer can dismiss; a false "trivial" verdict silently hides a real testing gap. Every classification therefore only claims what it can prove. - **The analysis stays a pure compile-time operation.** No test execution, no file system access from the analyzers or the generator, no network. Anything that cannot be decided from the compilation is a documented limitation, not a workaround. @@ -254,7 +248,6 @@ This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDU - **[Package README](src/NetEvolve.FrameShift/README.md)** - Installation, setup and configuration for consumers - **[Rule Documentation](docs/rules/README.md)** - One document per diagnostic, with causes and remedies -- **[Architecture Decision Records](decisions/)** - Detailed architectural decisions and rationale - **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to this project - **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations - **[License](LICENSE)** - Project licensing information diff --git a/templates/adr.md b/templates/adr.md deleted file mode 100644 index 816ac19..0000000 --- a/templates/adr.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -# List of authors who contributed to this decision. Include full names and roles if applicable. -authors: - - Name Surname # Replace with actual name - - Another Name Surname # Add more authors as needed - -# The patterns this decision applies to. Each entry is a glob pattern that matches files affected by this decision. -# Example: -# - "**/*.cs" # Applies to all C# files -# - "src/**/*.razor" # Applies to all Blazor components in src folder -# - "tests/**/*.sql" # Applies to all SQL files in tests folder -applyTo: - - "**/*" # Replace with specific glob patterns - -# The date this ADR was initially created in YYYY-MM-DD format. -created: YYYY-MM-DD - -# The most recent date this ADR was updated in YYYY-MM-DD format. -# IMPORTANT: Update this field whenever the decision is modified. -lastModified: YYYY-MM-DD - -# The current state of this ADR. If superseded, include references to the superseding ADR. -# Valid values: proposed, accepted, deprecated, superseded -state: proposed - -# A compact AI LLM compatible definition of this decision. -# This should be a precise, structured description that AI systems can easily parse and understand. -# Include the core decision, key rationale, and primary impact in 1-2 concise sentences. -instructions: | - Compact definition of the decision made and its core purpose. - Key rationale and primary impact on the project or development process. ---- - - -# Title - - - -## Context - - - -## Decision - - - -## Consequences - - - -## Alternatives Considered - - - -## Related Decisions (Optional) - -