From 250949f18ad6c72df16bce2ab6d32764c0af3a82 Mon Sep 17 00:00:00 2001 From: Mustafa Date: Mon, 28 Aug 2023 16:09:20 -0400 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 30f06f4f2..380552cfc 100644 --- a/README.md +++ b/README.md @@ -283,9 +283,9 @@ Now, the pre-commit hooks are installed and will run automatically before each c When you submit a PR, the "Python CI" workflow is triggered for code consistency. It follows organized steps to review your code: -1. **Python Black Check** : This step verifies code formatting using Python Black style, with the `--preview`` flag for style. +1. **Python Black Check** : This step verifies code formatting using Python Black style, with the `--preview` flag for style. -2. **Flake8 Review** : Next, Flake8 tool thoroughly checks code structure, including flake8-annotations and flake8-docstrings. Though GitHub Actions automates checks, it's wise to locally run `flake8 .`` before finalizing changes for quicker issue spotting and resolution. +2. **Flake8 Review** : Next, Flake8 tool thoroughly checks code structure, including flake8-annotations and flake8-docstrings. Though GitHub Actions automates checks, it's wise to locally run `flake8 .` before finalizing changes for quicker issue spotting and resolution. # Submitting an Issue