Skip to content

Commit

Permalink
docs/developing.md: Update outdated steps
Browse files Browse the repository at this point in the history
Update formatting to use ruff and provide some background info
about how the pip modules are installed.

Signed-off-by: Michael Kubacki <[email protected]>
  • Loading branch information
makubacki committed Sep 30, 2024
1 parent 8bd86b1 commit 6a918c9
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions docs/contributor/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,30 @@
## Testing
1. Run a Basic Syntax/Lint Check (using flake8) and resolve any issues
PIP modules used in this section such as `ruff` and `pydocstyle` are installed when you run `pip install -e .[dev]`
as described above.
``` cmd
flake8 .
```
> See [`pyproject.toml`](../../pyproject.toml) for the full list of development dependencies.
1. Run a Basic Syntax/Lint Check (using ruff) and resolve any issues
* Run ruff
``` cmd
ruff check .
```
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.
* Note: Newer editors are very helpful in resolving source formatting errors. For example, in VSCode, you can
open the Python file and use `Alt+Shift+F` to auto format. See the [Ruff VSCode extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
for more information.
2. Run a Basic Python docstring Check (using pydocstring) and resolve any issues
``` cmd
pydocstyle edk2toollib
```
* Run pydocstyle
``` cmd
pydocstyle edk2toollib
```
3. Run the `BasicDevTests.py` script to check file encoding, file naming, etc
Expand Down

0 comments on commit 6a918c9

Please sign in to comment.