diff --git a/docs/contributor/developing.md b/docs/contributor/developing.md index 78daa890..695d6583 100644 --- a/docs/contributor/developing.md +++ b/docs/contributor/developing.md @@ -75,9 +75,17 @@ 1. Run a Basic Syntax/Lint Check (using flake8) and resolve any issues - ``` cmd - flake8 . - ``` + * Install flake8 + + ```cmd + pip install flake8 + ``` + + * Run flake8 + + ``` cmd + flake8 . + ``` INFO: Newer editors are very helpful in resolving source formatting errors (whitespace, indentation, etc). In VSCode open the py file and use @@ -85,9 +93,17 @@ 2. Run a Basic Python docstring Check (using pydocstring) and resolve any issues - ``` cmd - pydocstyle edk2toollib - ``` + * Install pydocstyle + + ```cmd + pip install pydocstyle + ``` + + * Run pydocstyle + + ``` cmd + pydocstyle edk2toollib + ``` 3. Run the `BasicDevTests.py` script to check file encoding, file naming, etc