From 6a918c9d523e5f70f0a9746baf64269cf7832f13 Mon Sep 17 00:00:00 2001 From: Michael Kubacki Date: Mon, 30 Sep 2024 10:05:08 -0400 Subject: [PATCH] docs/developing.md: Update outdated steps Update formatting to use ruff and provide some background info about how the pip modules are installed. Signed-off-by: Michael Kubacki --- docs/contributor/developing.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/contributor/developing.md b/docs/contributor/developing.md index 78daa890..0e1d08fb 100644 --- a/docs/contributor/developing.md +++ b/docs/contributor/developing.md @@ -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