Skip to content

Commit

Permalink
docs/developing.md: Add some pip install steps
Browse files Browse the repository at this point in the history
Most contributors will likely know how to install the tools but for
those that don't give simple steps for commands shown to pass.

Signed-off-by: Michael Kubacki <[email protected]>
  • Loading branch information
makubacki committed Sep 30, 2024
1 parent 8bd86b1 commit be7bfba
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions docs/contributor/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,19 +75,35 @@
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
++alt+shift+f++ to auto format.
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
Expand Down

0 comments on commit be7bfba

Please sign in to comment.