[BUG] Our current CI/CD for code formatting is broken

[iuliaturc]

Describe the bug
Currently, the automation we have for code formatting here is broken in most cases.

My intention was to have an automation that runs isort and black --line-length=120 on every PR and adds a commit with formatted code. However:

• It actually fails most of the time
• It can't run on public PRs, needs the approval of the maintainers

To Reproduce
You can look at the history of actions, and see that it fails for various reasons (see example).

Expected behavior

• The less error-prone thing would be to have it run the formatting, but not attempt to make an actual commit.
• After removing the automated commit, we should make it easy for developers to run these formatting tools themselves by providing e.g. .vscode defaults.
• You can take inspiration from this GPT response and feel free to take liberties if you think there's a better practice here.

[laksh-krishna-sharma]

Hi @iuliaturc , may i work on this issue.