Skip to content

docs: update install and test instructions in README - #71

Merged
Coding-Dev-Tools merged 1 commit into
mainfrom
sync/readme-install-fix
Oct 3, 2026
Merged

Coding-Dev-Tools merged 1 commit into
mainfrom
sync/readme-install-fix

Conversation

@Coding-Dev-Tools

Copy link
Copy Markdown
Owner

Replaces template boilerplate npm install/test sections with working pip git+ install and pytest instructions.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

🤖 Automated Code Review

✅ Ruff Lint — No issues

⚠️ Ruff Format — Formatting needed

unformatted: File would be reformatted
   --> src/api_contract_guardian/cli.py:21:19
    |
20  |
    -     warnings.warn(
    -         "revenueholdings-license not installed; license checks skipped", stacklevel=2
    -     )
21  +     warnings.warn("revenueholdings-license not installed; license checks skipped", stacklevel=2)
22  |     _has_rh = False
--------------------------------------------------------------------------------
53  |
    - def _validate_output_format(
    -     format_name: str, allowed: tuple[str, ...], command: str
    - ) -> str:
54  + def _validate_output_format(format_name: str, allowed: tuple[str, ...], command: str) -> str:
55  |     """Reject unsupported output formats before the command runs."""
56  |     if format_name not in allowed:
57  |         allowed_list = ", ".join(allowed)
    -         raise typer.BadParameter(
    -             f"Unsupported {command} format '{format_name}'. Choose from: {allowed_list}"
    -         )
58  +         raise typer.BadParameter(f"Unsupported {command} format '{format_name}'. Choose from: {allowed_list}")
59  |     return format_name
--------------------------------------------------------------------------------
93  |     global _require_license_strict
    -     _require_license_strict = require_license_flag or bool(
    -         os.environ.get("REVENUEHOLDINGS_REQUIRE_LICENSE")
    -     )
94  +     _require_license_strict = require_license_flag or bool(os.environ.get("REVENUEHOLDINGS_REQUIRE_LICENSE"))
95  |

✅ Secret Detection — Clean

✅ Large Files — Within limits

📊 Diff Stats — 1 file(s) changed

 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Verdict: ⚠️ Warnings — Lint/format issues found. Recommend fixing before merge.

Automated by Coding-Dev-Tools/.github reusable workflow.

@Coding-Dev-Tools
Coding-Dev-Tools merged commit ea0e7bc into main Oct 3, 2026
5 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.

1 participant