# Catch the snag. Keep the evidence.

SnagBadger connects bug reporting, test planning, agent-driven testing, and regression work. Describe the behavior you expect, record what actually happened, and keep the useful evidence with the result.

Start with a small, inspectable workflow. The current repository supplies portable report APIs, Markdown test catalogs, runtime-driven execution, and reviewed local exports. The reporting interface is an experimental demonstration; live browser capture and tracker submission are separate work.

## Pick your starting point

- **Try it:** [Explore the maintained sample site](examples/sample-site.md). Switch between intentional buggy and fixed profile saves, then follow the same scenario through a test definition.
- **Use it:** [Choose a supported workflow](docs/getting-started/overview.md). Create a portable bug report or connect your own agent/browser runtime to a Markdown catalog.
- **Build it:** [Make your first contribution](docs/contributing/setup-and-first-change.md). Use the pinned toolchain, maintained checks, and a worktree-owned preview.

## From a problem to a useful record

A successful save message is not enough if the old value returns. SnagBadger keeps the expectation, actual behavior, attempted actions, and supporting evidence distinct. A failed test can become an editable bug report; a problem discovered during a passing test can too.

An export is a reviewed derivative of an identified report revision. It can be opened locally and inspected as structured data without an external tracker or server. [See how the pieces fit together](how-it-works.md).

## Know what you are trying

The examples intentionally include failures and simulated recording. The catalog describes tests to run; its existence does not prove that every test has been executed. Read [project status](project-status.md) before treating a demo as a production integration.

These pages describe the current repository version. The [public API reference](docs/reference/public-api.md) links supported entries; [GitHub issues](https://github.com/CosticaPuntaru/SnagBadger/issues) hold the canonical product decisions.

## License

SnagBadger is source available under [PolyForm Shield 1.0.0](https://github.com/CosticaPuntaru/SnagBadger/blob/main/LICENSE). It permits noncompeting commercial uses and restricts providing competing products or services using the software. See the [licensing notes](https://github.com/CosticaPuntaru/SnagBadger/blob/main/README.md#license) and full license for its conditions and exceptions. Third-party components retain their respective licenses.