sqa-bi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dedd5b9513ae1c858799e16819c4936b41efafaf6475a9aa0b8e0923dc1309bb
+  data.tar.gz: deeadd9357583787d6e3078c23eea4dc73c1544a76acc3e85687d8a17c1348a7
+SHA512:
+  metadata.gz: c95f2a403ded00c675827833e4b177a9d1a08e1ad246300d9a771f4d3207624218cc53348fc2d0224a6eb0fc6728a188090c94d7a6f9e6e1e749b5a95d47b93b
+  data.tar.gz: 47d3fc0e5264e5d9c27a89d99acce5326e25df8f83d3931670998a82fb06ed6325e439db012d5230912bb54caa1497d2b66ec5da9f4768cfe6da9cd130952020

data/.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+# Publish the MkDocs site to GitHub Pages.
+#
+# Requires Pages to be enabled for the repository with "GitHub Actions"
+# as the source (Settings → Pages → Build and deployment → Source).
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: docs/requirements.txt
+
+      - run: pip install -r docs/requirements.txt
+
+      # --strict turns the link and anchor validation in mkdocs.yml into
+      # build failures, so a broken cross-reference never ships.
+      - run: mkdocs build --strict
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

data/.quality/reek_baseline.txt

@@ -0,0 +1,5 @@
+1	lib/sqa/bi/likelihood.rb
+3	lib/sqa/bi/llm_support.rb
+3	lib/sqa/bi/posterior.rb
+1	lib/sqa/bi/prior.rb
+3	lib/sqa/bi/time_series_predictor.rb

data/.rubocop.yml

@@ -0,0 +1,224 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 4.0
+  Exclude:
+    - 'examples/**/*'
+    - 'docs/**/*'
+    - 'site/**/*'
+    - 'pkg/**/*'
+    - 'coverage/**/*'
+    # Untracked scratch/dev scripts left at repo root in sqa-tai (not part of the shipped gem)
+    - 'add_array_order_note.rb'
+    - 'complete_all_patterns.rb'
+    - 'generate_remaining_patterns.rb'
+
+# ── Style: disabled cops ───────────────────────────────────────────────────
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Ruby 4.0 freezes string literals by default
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/EmptyClassDefinition:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/OneClassPerFile:
+  Enabled: false
+
+# Both % and format/sprintf are acceptable
+Style/FormatString:
+  Enabled: false
+
+# String concatenation and interpolation are both acceptable
+Style/StringConcatenation:
+  Enabled: false
+
+# OpenStruct is a deliberate architectural choice throughout this ecosystem —
+# strategy/backtest/stream vectors are built as OpenStructs on purpose (see
+# sqa/CLAUDE.md). Not a candidate for a Struct/class/test-double rewrite.
+Style/OpenStructUse:
+  Enabled: false
+
+# $DEBUG_ME (debug_me gem convention) and test fixture globals like $data are
+# established patterns here, not accidental global-variable leaks.
+Style/GlobalVars:
+  Enabled: false
+
+# ── Layout ─────────────────────────────────────────────────────────────────
+Layout/LineLength:
+  Max: 140
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# ── Naming ─────────────────────────────────────────────────────────────────
+# Single-char params (c, e, n) are acceptable throughout
+Naming/MethodParameterName:
+  Enabled: false
+
+# sma_20, percentile_95, and similar parameterized names are more readable
+# than the normalcase default (sma20, percentile95). alpha_vantage_api.rb is
+# excluded entirely: it mirrors Alpha Vantage's literal API function/parameter
+# names (t3, timeperiod1/2/3, ...) verbatim, which we can't rename. Same
+# reasoning for sqa-tai's overlap_studies.rb (t3) and momentum_indicators.rb
+# (ultosc's time_period1/2/3) — TA-Lib's own C function/parameter names.
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+  Exclude:
+    - 'test/**/*'
+    - 'lib/api/alpha_vantage_api.rb'
+    - 'lib/sqa/tai/overlap_studies.rb'
+    - 'lib/sqa/tai/momentum_indicators.rb'
+    - 'lib/sqa/data_frame/yahoo_finance.rb' # period1/period2 mirror Yahoo's own chart API query params verbatim
+
+# sqa-cli's gem entry point must be lib/sqa-cli.rb (hyphen) so that
+# `require 'sqa-cli'` resolves by exact match on the gem name; renaming to
+# snake_case would break the require path. (Only sqa-cli has such a file.)
+# Archspec.rb must be PascalCase, matching the archspec gem's own
+# Rakefile/Gemfile-style convention-named config file.
+Naming/FileName:
+  Exclude:
+    - 'lib/sqa-cli.rb'
+    - 'Archspec.rb'
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+# set_results and similar explicit setters are clear and conventional
+Naming/AccessorMethodName:
+  Enabled: false
+
+# has_tool_calls? and similar are clear and conventional
+Naming/PredicatePrefix:
+  Enabled: false
+
+# Test helper methods don't need to follow predicate naming rules
+Naming/PredicateMethod:
+  Exclude:
+    - 'test/**/*'
+
+# ── Lint: relax noisy cops on intentional patterns ─────────────────────────
+Lint/EmptyBlock:
+  Exclude:
+    - 'test/**/*'
+
+# Library and framework methods commonly accept args for API/documentation purposes
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'Rakefile'
+    - 'test/**/*'
+
+# ── Gemspec ────────────────────────────────────────────────────────────────
+# All 5 sqa gem repos declare dev deps directly in the gemspec (not a Gemfile
+# group) — the opposite convention from robot_lab_project, so match reality.
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+# ── Metrics ────────────────────────────────────────────────────────────────
+# Flog is the primary complexity gate (see repo_dev.loki flog_check) — these
+# RuboCop thresholds catch only egregious outliers without duplicating flog's
+# more precise per-method scoring.
+
+Metrics/MethodLength:
+  Max: 35
+  CountAsOne:
+    - heredoc
+    - array
+    - hash
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+
+Metrics/ClassLength:
+  Max: 650 # matches robot_lab_project: central orchestrator classes are legitimately large
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+
+Metrics/ModuleLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+    # Many independent thin TA-Lib indicator wrappers — naturally long by breadth, not complexity
+    - 'lib/sqa/tai/pattern_recognition.rb'
+    - 'lib/sqa/tai/momentum_indicators.rb'
+    # Cohesive groups of route helpers extracted during the flog complexity pass
+    - 'lib/sqa_demo/sinatra/helpers/api_helpers.rb'
+    - 'lib/sqa_demo/sinatra/helpers/stock_loader.rb'
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+
+Metrics/PerceivedComplexity:
+  Max: 20
+  Exclude:
+    - 'test/**/*'
+    - 'bin/**/*'
+
+# Long method signatures with keyword args are common in this codebase
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - 'test/**/*'
+    - 'bin/**/*'

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## [0.1.0] - 2026-09-20
+
+Initial release. Ported from the `bayesian_inference` prototype in
+`experiments/ai_misc/` into the SQA workspace under the `SQA::BI`
+namespace.
+
+### Added
+
+- `SQA::BI::Prior` — prior distributions over discrete outcomes, with
+  Laplace smoothing, weighted combination, and entropy.
+- `SQA::BI::Likelihood` — Gaussian kernel density estimation of
+  P(features | outcome) from historical observations.
+- `SQA::BI::Posterior` — Bayes' theorem, plus entropy, confidence,
+  KL divergence from the prior, MAP estimate, and sampling.
+- `SQA::BI::TimeSeriesPredictor` — the main `train` / `predict` interface.
+- `SQA::BI::LlmPriorElicitor` — an LLM supplies the prior from a
+  natural-language description of the situation.
+- `SQA::BI::LlmLikelihoodEstimator` — an LLM acts as a likelihood
+  function over textual evidence; Ruby chains the updates.
+- `SQA::BI::LlmSupport` — provider resolution (LM Studio, Apfel, cloud),
+  JSON extraction, re-keying, normalization, and clamping.
+- Examples `01`–`05`, including a market prediction demo that bridges
+  `SQA::DataFrame`.
+
+### Changed from the prototype
+
+- Namespace `BayesianInference` → `SQA::BI`; entry point `require "sqa/bi"`.
+- Environment overrides are now `SQA_BI_LLM_PROVIDER` / `SQA_BI_LLM_MODEL`.
+  The unprefixed `BI_LLM_*` names are still honored as a fallback.
+- Adopted the workspace quality gates (RuboCop, Flog, Flay, Reek,
+  SimpleCov) and the `asgard` / direnv bundle-mode conventions.

data/CLAUDE.md

@@ -0,0 +1,128 @@
+# CLAUDE.md
+
+Guidance for Claude Code (claude.ai/code) working in this repository.
+The workspace-level `sqa_project/CLAUDE.md` covers cross-repo structure,
+bundle mode, and the shared quality gates; this file covers what is
+specific to `sqa-bi`.
+
+## What this gem is
+
+`SQA::BI` does Bayesian inference over a small ordered set of discrete
+outcomes (typically `[-2, -1, 0, 1, 2]`) given a numeric feature vector.
+Prior × likelihood → posterior, where the likelihood is a Gaussian kernel
+density estimate over historical observations. The posterior reports
+entropy, confidence, KL divergence from the prior, MAP, and sampling.
+
+**The core math is domain-agnostic — it knows nothing about markets.**
+Keep it that way. Market-facing code belongs in `sqa`, or in the examples.
+
+## Dependency position — this is a LEAF
+
+```
+sqa-tai  ─┐
+sqa-bi   ─┴→  sqa  →  sqa-cli / sqa-advisor / sqa-rails / sqa-sinatra
+```
+
+`sqa-bi` has **no runtime dependencies at all** and deliberately does
+**not** depend on `sqa` — it sits beside `sqa-tai` so that `sqa` can
+depend on IT. Do not add a `sqa` dependency to the gemspec; that would
+invert the graph and create a cycle the moment `sqa` picks this gem up.
+
+`examples/03_stock_market_prediction_v2.rb` does need `sqa`, and gets it
+from `Gemfile.local` (`gem "sqa", path: "../sqa"`) in dev bundle mode
+only. Run it with `asgard dev` active at the workspace root.
+
+### The ruby_llm resolution, since it looks like a conflict
+
+`sqa` → `shared_tools` → `ruby_llm-mcp`, which pins `ruby_llm ~> 1.9`,
+while `sqa` itself and the local provider gems want `ruby_llm >= 2.0`.
+Bundler resolves this by backing `shared_tools` down to 0.2.3, which has
+no `ruby_llm-mcp` dependency — the same resolution `sqa`'s own
+`Gemfile.local.lock` lands on. Verified: `Gemfile.local` here resolves
+`sqa 0.4.0` + `ruby_llm 2.0.0` + `shared_tools 0.2.3`, and example 03
+runs end to end. If a future `shared_tools` release drops the
+`ruby_llm-mcp` pin, this note becomes moot.
+
+## The LLM design rule
+
+> **The LLM judges. Ruby computes.**
+
+Ask the LLM only for isolated, independent judgments — a relative weight,
+a single conditional probability. Never ask it to accumulate, normalize,
+or update beliefs; that is Bayes' job, done in Ruby. Every change to
+`LlmPriorElicitor` or `LlmLikelihoodEstimator` must preserve this split.
+
+Consequences already baked in, don't remove them:
+
+- `ruby_llm` is required **lazily** inside `LlmSupport.build_chat`, so
+  the core math library loads and the KDE path works without it. It is a
+  development dependency only.
+- Both LLM classes accept an injectable `chat:` object; `FakeChat` in
+  `test/test_helper.rb` keeps the suite at zero network calls. Keep it
+  that way — no test may hit a real provider.
+- Likelihoods are clamped to `[0.001, 0.999]` (Cromwell's rule) so an
+  overconfident model can never zero out a hypothesis in one step.
+- `LlmSupport` methods are all `module_function` so each is testable in
+  isolation.
+
+Provider resolution is local-first: LM Studio → Apfel → cloud. Override
+with `SQA_BI_LLM_PROVIDER` / `SQA_BI_LLM_MODEL`; the unprefixed
+`BI_LLM_*` names from before the workspace move are honored as a
+fallback (`LlmSupport.env_value`).
+
+**The fallback to cloud is silent**, and that has already cost debugging
+time once: LM Studio's desktop app running is not the same as its server
+running (`lms status` → `lms server start`), and a server with only
+embedding models loaded resolves to no chat model at all. Either way
+resolution drops to cloud, hits `CLOUD_DEFAULT_MODEL`
+(`claude-haiku-4-5`), and surfaces as an Anthropic 401 rather than
+anything mentioning LM Studio. `LlmSupport.current_resolution` exists to
+make that visible, and examples 04/05 print it before their first call —
+keep that, and prefer it to adding warnings inside the library.
+
+## Quality gates
+
+Standard workspace setup — `asgard quality` runs tests+coverage, Flog,
+Flay, and Reek. Notes specific to this repo:
+
+- `.quality/reek_baseline.txt` grandfathers **11** smells across 5 files,
+  all deliberate:
+  - FeatureEnvy in the `reduce`-based `Prior#entropy`,
+    `Posterior#entropy`, `#kl_divergence_from_prior`, and
+    `Likelihood#euclidean_distance`.
+  - TooManyStatements in `configure_ruby_llm` and `compute_posterior`.
+  - ControlParameter in `LlmSupport.local_api_base` and
+    `.resolution_label` — both are small lookup/format functions where
+    branching on the argument *is* the function.
+  - BooleanParameter / ControlParameter on `TimeSeriesPredictor`'s
+    `update_prior:` and `reset!(keep_prior:)` — API shape, not accidents.
+
+  Regenerate with `asgard reek_baseline` after a real improvement. Note
+  the counting subtlety if you ever hand-edit the file: reek prints
+  "1 warning:" (singular) for single-smell files, so grepping for
+  "warnings:" silently drops them — derive counts from
+  `Reek::Examiner`, the way `rake reek_check` does.
+- `SQA::BI::Posterior#summary` sits at Flog 21.2 — above the warn
+  threshold, below the fail threshold. It is a formatting heredoc.
+- `.rubocop.yml` is generated from the workspace `.rubocop.yml.common`.
+  Edit that and run `asgard sync_rubocop`; don't edit this repo's copy.
+
+## History and open threads
+
+Ported 2026-09-20 from the `bayesian_inference` prototype in
+`~/sandbox/git_repos/madbomber/experiments/ai_misc/`. The running
+investigation log is `decision_support_techniques.md` in this repo —
+read it before proposing a different inference engine, since the
+tree-ensemble (`eps`/LightGBM) and Laya typed-decision routes were each
+evaluated there and set aside for recorded reasons.
+
+Open, per that log:
+
+- Multi-horizon prediction (k = 1…10), sharing strength across horizons
+  rather than fitting each independently. `TimeSeriesPredictor` is
+  single-horizon today.
+- A Laya sidecar as an alternative likelihood backend behind
+  `LlmSupport`'s provider dispatch, benchmarked on latency and ECE.
+- `eps`/LightGBM kept as a **benchmark** to score the posterior against,
+  not as a replacement engine.
+- Research JEV properly before it influences any design decision.

data/COMMITS.md

@@ -0,0 +1,196 @@
+---
+url: https://www.conventionalcommits.org/en/v1.0.0/
+title: Conventional Commits
+description: A specification for adding human and machine readable meaning to commit messages
+access_date: 2025-07-31T20:51:29.000Z
+current_date: 2025-07-31T20:51:29.601Z
+---
+
+# Conventional Commits
+
+A specification for adding human and machine readable meaning to commit messages
+
+ Quick Summary Full Specification Contribute
+
+# Conventional Commits 1.0.0
+
+## Summary
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+
+---
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+```
+
+---
+
+The commit contains the following structural elements, to communicate intent to the consumers of your library:
+
+1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with `PATCH` in Semantic Versioning).
+2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with `MINOR` in Semantic Versioning).
+3. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A BREAKING CHANGE can be part of commits of any _type_.
+4. _types_ other than `fix:` and `feat:` are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends `build:`, `chore:`,`ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
+5. _footers_ other than `BREAKING CHANGE: <description>` may be provided and follow a convention similar to git trailer format.
+
+Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
+
+## Examples
+
+### Commit message with description and breaking change footer
+
+```
+feat: allow provided config object to extend other configs
+
+BREAKING CHANGE: `extends` key in config file is now used for extending other config files
+
+```
+
+### Commit message with `!` to draw attention to breaking change
+
+```
+feat!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with scope and `!` to draw attention to breaking change
+
+```
+feat(api)!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with both `!` and BREAKING CHANGE footer
+
+```
+chore!: drop support for Node 6
+
+BREAKING CHANGE: use JavaScript features not available in Node 6.
+
+```
+
+### Commit message with no body
+
+```
+docs: correct spelling of CHANGELOG
+
+```
+
+### Commit message with scope
+
+```
+feat(lang): add Polish language
+
+```
+
+### Commit message with multi-paragraph body and multiple footers
+
+```
+fix: prevent racing of requests
+
+Introduce a request id and a reference to latest request. Dismiss
+incoming responses other than from latest request.
+
+Remove timeouts which were used to mitigate the racing issue but are
+obsolete now.
+
+Reviewed-by: Z
+Refs: #123
+
+```
+
+## Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
+
+1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space.
+2. The type `feat` MUST be used when a commit adds a new feature to your application or library.
+3. The type `fix` MUST be used when a commit represents a bug fix for your application.
+4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
+5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_.
+6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
+7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
+8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a `:<space>` or `<space>#` separator, followed by a string value (this is inspired by the git trailer convention).
+9. A footer’s token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token.
+10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
+11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
+12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g.,_BREAKING CHANGE: environment variables now take precedence over config files_.
+13. If included in the type/scope prefix, breaking changes MUST be indicated by a`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
+14. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., _docs: update ref docs._
+15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
+16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.
+
+## Why Use Conventional Commits
+
+* Automatically generating CHANGELOGs.
+* Automatically determining a semantic version bump (based on the types of commits landed).
+* Communicating the nature of changes to teammates, the public, and other stakeholders.
+* Triggering build and publish processes.
+* Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.
+
+## FAQ
+
+### How should I deal with commit messages in the initial development phase?
+
+We recommend that you proceed as if you’ve already released the product. Typically _somebody_, even if it’s your fellow software developers, is using your software. They’ll want to know what’s fixed, what breaks etc.
+
+### Are the types in the commit title uppercase or lowercase?
+
+Any casing may be used, but it’s best to be consistent.
+
+### What do I do if the commit conforms to more than one of the commit types?
+
+Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
+
+### Doesn’t this discourage rapid development and fast iteration?
+
+It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
+
+### Might Conventional Commits lead developers to limit the type of commits they make because they’ll be thinking in the types provided?
+
+Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
+
+### How does this relate to SemVer?
+
+`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
+
+### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
+
+We recommend using SemVer to release your own extensions to this specification (and encourage you to make these extensions!)
+
+### What do I do if I accidentally use the wrong commit type?
+
+#### When you used a type that’s of the spec but not the correct type, e.g. `fix` instead of `feat`
+
+Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
+
+#### When you used a type _not_ of the spec, e.g. `feet` instead of `feat`
+
+In a worst case scenario, it’s not the end of the world if a commit lands that does not meet the Conventional Commits specification. It simply means that commit will be missed by tools that are based on the spec.
+
+### Do all my contributors need to use the Conventional Commits specification?
+
+No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they’re merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
+
+### How does Conventional Commits handle revert commits?
+
+Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch?
+
+Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexibility of _types_ and _footers_ to develop their logic for handling reverts.
+
+One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted:
+
+```
+revert: let us never again speak of the noodle incident
+
+Refs: 676104e, a215868
+
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Dewayne VanHoozer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.