Skip to content

[Enhancement] Add format checks#26

Merged
vipul-mittal merged 2 commits intomainfrom
scratch/add_format_checks
Sep 11, 2025
Merged

[Enhancement] Add format checks#26
vipul-mittal merged 2 commits intomainfrom
scratch/add_format_checks

Conversation

@psriramsnc
Copy link
Collaborator

@psriramsnc psriramsnc commented Sep 11, 2025

Summary

✅ Check Format Workflow

This PR introduces a GitHub Actions workflow to automatically check code formatting on every push and pull request.
It ensures consistency using Black and isort, preventing formatting issues from reaching main.


🔧 Workflow Details

  • Trigger:

    • Push to main
    • Pull Requests (opened, synchronized, reopened, ready-for-review)
  • Steps Included:

    1. 📥 Checkout Code – Pulls the repository for analysis
    2. 🐍 Set up Python 3.9 – Ensures a consistent Python environment
    3. 📦 Install Poetry – Dependency manager with in-project virtualenvs
    4. Cache Dependencies – Speeds up workflow runs with Poetry venv caching
    5. 🔄 Install Dependencies – Runs make setup-dev when cache is missing
    6. 📝 Check Formatting – Runs make check-format (black, isort)

🚀 Benefits

  • 🧹 Automatic formatting checks before merging
  • ⚡ Faster runs with caching
  • 🛡️ Enforces consistent style across the codebase

Performance impact (if any):

N/A

How to Test the feature

Run make format

Screenshots (if applicable)

N/A

Checklist

  • Lint fixes and unit testing done
  • End to end task testing
  • Documentation updated

Notes

N/A

@psriramsnc psriramsnc requested a review from a team September 11, 2025 05:37
@psriramsnc psriramsnc self-assigned this Sep 11, 2025
@vipul-mittal vipul-mittal enabled auto-merge (squash) September 11, 2025 05:52
@vipul-mittal vipul-mittal merged commit d961ae9 into main Sep 11, 2025
2 checks passed
@vipul-mittal vipul-mittal deleted the scratch/add_format_checks branch September 11, 2025 06:02
@psriramsnc psriramsnc changed the title Add format checks [Enhancement] Add format checks Sep 13, 2025
@psriramsnc psriramsnc added the enhancement New feature or request label Sep 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants