Skip to content

Polish the README for a support and QA portfolio - #3

Merged
dkupratis-debug merged 1 commit into
mainfrom
cursor/polish-readme-8eab
Nov 12, 2026
Merged

dkupratis-debug merged 1 commit into
mainfrom
cursor/polish-readme-8eab

Conversation

@dkupratis-debug

Copy link
Copy Markdown
Owner

Summary

Rewrites README.md so a support, QA, or tooling reader can see what sqt does and run it.

  • Opens with one sentence on what the tool is for, then one real sqt ticket2bug run. The fenced report is the stdout of that command on samples/tickets/export-hang.txt.
  • Setup now starts with python3 -m venv. On a machine where python is not on PATH, the old python -m venv line fails before the venv exists. Debian and Ubuntu also need the python3-venv package when ensurepip is missing.
  • The severity table matches the rules in src/sqt/severity.py, including priorities the previous table left out (highest, Sev-0, P4, lowest, and the rest).
  • Adds the CI badge for .github/workflows/ci.yml, a project layout, and the existing MIT license line. Sample data is still described as fictional.

Test plan

  • python3 -m venv and python -m pip install -e . produce a working sqt
  • python -m pip install -e ".[dev]", then ruff check . and pytest (57 passed)
  • Pasted example matches the command stdout byte for byte
  • CI on this pull request (ruff check . and pytest -q on Python 3.11)
Open in Web Open in Cursor 

Document python3 for venv setup, add the CI badge, and align the severity list with the rules the code actually matches.

Co-authored-by: David Kupratis <dkupratis@student.bccc.edu>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-12T12:56:49.952437Z df4f6ed PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@dkupratis-debug
dkupratis-debug merged commit 6afe4f1 into main Nov 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants