Skip to content

Conversation

@qjrm1430
Copy link
Member

✅ Review Readiness Checklist (Required before review)

Complete all items below before marking your PR ready for review. After completion, delete these instructions and replace with your actual PR message.

  • PR title format: {TYPE}({SCOPE}): {DESCRIPTION}

    • Examples:
      • feat(cli): add cast scaffolding option
      • fix(scaffold): resolve snake_case normalization bug
      • docs(readme): clarify Python 3.12+ requirement
    • Allowed {TYPE} values:
      • feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, release
    • Allowed {SCOPE} values (optional): project area
      • cli, scaffold, utils, docs, tests, workflow, cookiecutter
    • Once you've written the title, delete this checklist item.
  • PR message: Replace this entire checklist with the template below

    • Description: Describe the change. Include a linking a pull request to an issue keyword if applicable.
    • Issue: The related issue number (e.g., Fixes #123)
    • Dependencies: Any dependencies required for this change
    • SNS handle: If announced publicly, add your handle for a shoutout
  • Add tests and docs: If you add a new feature/integration, include

    1. Tests: Prefer unit tests without network access (integration tests as needed)
    2. Docs/examples: Update user-facing docs/examples
      • Update README.md or scaffold template docs (e.g., act_operator/act_operator/scaffold/{{ cookiecutter.project_dir }}/README.md)
  • Lint and test: From the root of modified package(s), run and ensure all pass

    uv run ruff check .
    uv run pytest -q

    We will not consider a PR unless these two pass in CI. See CONTRIBUTING.md for more.

Additional guidelines

  • Import optional dependencies inside functions (lazy import).
  • Do not add dependencies to pyproject.toml (even optional) unless required for runtime/tests.
  • Most PRs should modify only one area/scope.
  • Changes must be backwards compatible.

📝 Summary

📄 Description

🔗 Issue / Dependencies / Mentions

  • Issue:
  • Dependencies:
  • SNS handle:

✅ Local Checks

  • uv run ruff check . passed
  • uv run pytest -q passed

💡 Notes (Optional)

🔗 Related Issue(s)

@qjrm1430 qjrm1430 self-assigned this Jan 14, 2026
@qjrm1430 qjrm1430 merged commit 22290c8 into main Jan 14, 2026
4 of 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.

2 participants