Skip to content

improve: expand AGENTS.md with CI/CD, agent workflow, and business context #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Coding-Dev-Tools wants to merge 1 commit into
base: main
Choose a base branch
from
Open

improve: expand AGENTS.md with CI/CD, agent workflow, and business context #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,35 @@
This repo converts JSON to SQL. Primary implementation is under `src/json2sql/`. CLI entrypoints live in `cli.py` and `__main__.py`.

## Commands
- Install/dev: `pip install -e .`
- Tests: `pytest`
- Lint/type checks (if configured): use tooling in `pyproject.toml`
- Install/dev: `pip install -e ".[dev]"`
- Tests: `pytest tests/ -v`
- Lint: `ruff check src/ tests/`
- Format: `ruff format src/ tests/`
- Type check: `mypy src/` (if configured)

## CI/CD
- **CI** (`.github/workflows/ci.yml`): Tests on Python 3.10-3.13 + ruff lint
- **Auto Code Review** (`.github/workflows/auto-code-review.yml`): Reusable org workflow
- **Pages** (`.github/workflows/pages.yml`): Deploy docs to GitHub Pages
- **Publish** (`.github/workflows/publish.yml`): PyPI publish on tags

## Agent workflow
1. `git checkout main && git pull origin main`
2. `git checkout -b improve/json2sql-<YYYYMMDD>`
3. Make changes (max 50 lines per run)
4. `ruff check src/ tests/ && ruff format src/ tests/`
5. `pytest tests/ -v` — ensure all tests pass
6. `git add -A && git commit -m "improve: <description>"`
7. `git push origin improve/json2sql-<YYYYMMDD>`
8. `gh pr create --title "improve: <description>" --body "Automated improvement by dev-engineer." --repo Coding-Dev-Tools/json2sql`

## Do not break
- Do not remove or weaken existing tests.
- Keep public CLI behavior stable unless an issue explicitly requests changing it.
- Do not change the `convert()` function signature or return type.
- Keep lazy imports inside `convert()` to preserve cold-start optimization.

## Business context
- Part of **Coding-Dev-Tools** under **Revenue Holdings**
- Revenue Holdings north star: "Generate revenue through CLI tools, SaaS products, and automated operations."
- This is a Tier 2 repo (developer tool / CLI utility)
Loading