Skip to content

Conversation

aseembits93
Copy link
Contributor

@aseembits93 aseembits93 commented Aug 6, 2025

PR Type

Documentation


Description

  • Add Claude.md with linting and formatting commands

  • Include ruff and mypy instructions for code checks

  • Add placeholder Code style section

  • Add workflow tips: typecheck and focused tests


File Walkthrough

Relevant files
Documentation
Claude.md
Create Claude.md linting and workflow guide                           

Claude.md

  • Added Bash commands section for linting and formatting
  • Included ruff check --fix and ruff format commands
  • Added mypy typechecking instructions
  • Added workflow guidelines for code checks and tests
+12/-0   

Copy link

github-actions bot commented Aug 6, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Incomplete Command

The mypy command line ends with a hyphen and may be truncated. Ensure the full invocation and any allowlist file are specified correctly.

- mypy --non-interactive --config-file pyproject.toml @mypy_allowlist.txt: mypy typechecker- 
Empty Section

The Code style section is left blank. Add the intended style guidelines or remove the placeholder to avoid confusion.

# Code style
- 
- 

Copy link

github-actions bot commented Aug 6, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

Comment on lines +1 to +7
# Bash commands
- `ruff check --fix --exit-non-zero-on-fix --config=pyproject.toml .`: Run the linter
- `ruff format .`: Run the formatter
- `mypy --non-interactive --config-file pyproject.toml @mypy_allowlist.txt`: mypy typechecker

# Running tests
- Run tests with `pytest tests/`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these will all fail because we're using uv in order to run these commands, maybe using hooks is a better approach https://docs.anthropic.com/en/docs/claude-code/hooks-guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants