maxtext icon indicating copy to clipboard operation
maxtext copied to clipboard

Quality report table + instructions for Pull Requests

Open SamuelMarks opened this issue 4 months ago • 0 comments

Description

Even when everything has pre-commit hooks (#1994) there is still opportunity for low quality code to get into main, as both --no-verify and CI checks can be disabled. At least with this PR a comment will be automatically attached to each PR that will check its quality and report to the user in an easy to read manner with full instructions for addressing any detected issues.

The report will look something like:

filename coverage pyink pylint pytype codespell
a.py 🔴 🔴 🔴 🟢
f.ipynb 🔴 🟢 🔴 🟢

On your changes you need to run:

python3 -m pylint --disable C0114,R0401,R0917,W0201,W0613

On your changes you need to run:

pyink --pyink-indentation=2 --line-length=122

On your changes you need to run:

pytype --jobs auto --keep-going

Note: only whence tool invocation fail (🔴 not 🟢|⚪) are instructions included.

Tests

N/A

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • [x] I have performed a self-review of my code.
  • [x] I have necessary comments in my code, particularly in hard-to-understand areas.
  • [x] I have run end-to-end tests tests and provided workload links above if applicable.
  • [x] I have made or will make corresponding changes to the doc if needed.

WiP this is a draft

SamuelMarks avatar Aug 22 '25 02:08 SamuelMarks