Skip to content

docs: backend module renamed to github.com/optiqor/optiqor; fix CI ba…#21

Merged
btwshivam merged 2 commits into
mainfrom
docs/backend-module-rename
May 17, 2026
Merged

docs: backend module renamed to github.com/optiqor/optiqor; fix CI ba…#21
btwshivam merged 2 commits into
mainfrom
docs/backend-module-rename

Conversation

@btwshivam
Copy link
Copy Markdown
Member

…dge URL

The proprietary monorepo's Go module changed from
github.com/optiqor/backend to github.com/optiqor/optiqor. Update the "forbidden import" rule in CLAUDE.md and todo.md so the OSS guardrail references the current name.

CI badge URL in README.md was pointing at the wrong workflow path (optiqor/optiqor instead of optiqor/optiqor-cli) — fixed.

What

Why

Fixes #

How

Testing

  • make lint test passes locally
  • go test -race ./... passes
  • If a new rule: added a chart fixture in testdata/ and a golden output
  • Tested locally with:

Checklist

  • PR title follows Conventional Commits (feat(scope): subject)
  • All commits are DCO-signed (git commit -s)
  • No unrelated changes pulled in
  • Documentation updated where user-visible behavior changed
  • No LLM calls or telemetry introduced
  • No proprietary backend imports

…dge URL

The proprietary monorepo's Go module changed from
github.com/optiqor/backend to github.com/optiqor/optiqor. Update the
"forbidden import" rule in CLAUDE.md and todo.md so the OSS guardrail
references the current name.

CI badge URL in README.md was pointing at the wrong workflow path
(optiqor/optiqor instead of optiqor/optiqor-cli) — fixed.
@github-actions
Copy link
Copy Markdown

First PR — welcome aboard!

A few things to expect:

  1. CI: every PR runs build + race tests + lint on Ubuntu and macOS. If something fails, the log will tell you exactly which gate.
  2. DCO: every commit needs Signed-off-by:. git commit -s adds it automatically.
  3. Conventional Commits: PR titles like feat(analyze): new rule or fix(cli): handle X. We squash-merge by default.
  4. Review: a maintainer will review within 72 hours. Suggestions are conversations, not orders — push back if something doesn't fit your context.

If you get stuck, reply here or jump to Discussions. We want this PR to land.

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/XS 10 lines or fewer labels May 17, 2026
Two cross-repo links (../todo.md, ../docs/open_source_cli_playbook.md)
only resolve in the dev's local checkout where optiqor-cli is a
sibling of the proprietary monorepo. They 404 in CI which only has
this repo. Replaced with descriptive prose.

External links: replaced the stale sigstore docs URL with the cosign
repo (stable). Added ignorePatterns for the unpublished npm package
URL and the (not-yet-enabled) Discussions tab.
@github-actions github-actions Bot added size/S 11–50 lines and removed size/XS 10 lines or fewer labels May 17, 2026
@btwshivam btwshivam merged commit a2ebc34 into main May 17, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S 11–50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant