Skip to content
fabricators docs
On this page

Apply the same rules to every app

Use source conventions, analyzers and package-consumer verification.

Our own packages and third-party integrations need readable source, explicit dependencies and reproducible verification.

Source layout

Place fields/properties first, constructors next, visible behavior after them, private helpers afterwards and nested types last. Separate members with blank lines. Target 80 columns and split long conditions, argument lists and object initializers rather than compressing them into unreadable lines.

Fabricators.Authoring provides the selected StyleCop profile and copied formatter templates. Fabricators.Authoring.Tool provides the Roslyn-based source-layout checker. Tools use the .NET SDK; verification has Windows cmd and Linux/macOS shell entrypoints without requiring Python or Node.

Explicit integration

Declare approved package/assembly dependencies. Do not scan every loaded assembly for implementations. Validation registration uses the host-selected assemblies; domain invariants and transactional constraints remain with their owner.

Verify a contribution

Run locked restore, formatting/analyzers, member-layout checks, Release build and tests. Pack the artifact and consume it from outside the checkout to expose missing files or dependency leaks that project-reference tests can hide.

Version 0.7.0 also checks unused imports across the whole solution and build runner with IDE0005 at info severity. Run the format mode to remove them and the normal verification mode to reject regressions. The runner enables documentation parsing only for this Roslyn check, because IDE0005 requires it; it does not force XML comments or suppress missing-documentation warnings in production builds. An independent installed-authoring consumer must reject an unused-using fixture.

Documentation is part of the contract: add an objective-driven guide, prerequisites, configuration, expected result, meaningful failure/recovery paths and links to the actual API. Label examples according to their verification evidence.

Continue with documentation contribution rules.

↑ ↓ to move↵ to openSearching fabricators .NET foundation v0.19.0