Description
The CONTRIBUTING.md file instructs developers to run ./autoformat.sh to automatically format the code. This file does not exist in the repository.
This is likely a documentation error, possibly from copying the contribution guide from another repository.
Proposed Solution
We should add the autoformat.sh script to the repository root to match the documentation. This script should contain the commands to run isort and pyink as defined in the pyproject.toml.
Example script:
#!/bin/bash
# Auto-formats the repository code using isort and pyink.
set -e
echo "Running isort..."
isort .
echo "Running pyink..."
pyink .
echo "Formatting complete."
Description
The
CONTRIBUTING.mdfile instructs developers to run./autoformat.shto automatically format the code. This file does not exist in the repository.This is likely a documentation error, possibly from copying the contribution guide from another repository.
Proposed Solution
We should add the
autoformat.shscript to the repository root to match the documentation. This script should contain the commands to runisortandpyinkas defined in thepyproject.toml.Example script: