Skip to content

Docs: autoformat.sh script is missing but referenced in CONTRIBUTING.md #10

@ariefshaik7

Description

@ariefshaik7

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."

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions