Examples

Each directory is a complete, self-contained project: it has its own requirements.yaml, definitions and source documents, and it runs on its own. Nothing outside the directory reads these files.

Directory	Shows
yaml	YAML definitions with a sourced requirement, specifications and an independent decision
markdown	The same definitions written as readable Markdown cards (experimental)
extensions	A custom source extension and a custom test runner loaded through `bootstrap`

Run an example from its directory with the package's command:

cd examples/yaml
php ../../bin/requirements lint
php ../../bin/requirements format --check
php ../../bin/requirements check
php ../../bin/requirements coverage

The extensions example also links a test, so php ../../bin/requirements spec executes it through the custom runner.

documentExamples

Examples