Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/developing.md: Update outdated steps #645

Merged
merged 3 commits into from
Oct 1, 2024
+20 −16
Merged

docs/developing.md: Update outdated steps #645

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a918c9
docs/developing.md: Update outdated steps
makubacki Sep 30, 2024
e9a01a4
PR Update: Remove pydocstyle step
makubacki Sep 30, 2024
c771fc4
PR Update: Fix typo
makubacki Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions docs/contributor/developing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,29 +73,33 @@

## 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
makubacki marked this conversation as resolved.
Show resolved Hide resolved
flake8 .
```
> See [`pyproject.toml`](../../pyproject.toml) for the full list of development dependencies.

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.
1. Run a Basic Syntax/Lint Check (using ruff) and resolve any issues

2. Run a Basic Python docstring Check (using pydocstring) and resolve any issues
* Run ruff

``` cmd
pydocstyle edk2toollib
```
``` cmd
ruff check .
```

* 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.

* Note: `ruff` is a wrapper around tools like `pydocstyle`. See [`pyproject.toml`](../../pyproject.toml) for
more details.

3. Run the `BasicDevTests.py` script to check file encoding, file naming, etc
2. Run the `BasicDevTests.py` script to check file encoding, file naming, etc

```cmd
BasicDevTests.py
```

4. Run Coverage with pytest test execution
3. Run Coverage with pytest test execution

``` cmd
coverage run -m pytest
Expand All @@ -106,19 +110,19 @@

Coverage is uploaded to `codecov.io`.

5. Generate and review the html report
4. Generate and review the html report

```cmd
coverage html
```

6. Run the spell checker
5. Run the spell checker

```cmd
cspell -c .cspell.json "**/*.py" "**/*.md"
```

7. Run the markdown linter
6. Run the markdown linter

```cmd
markdownlint "**/*.md"
Expand Down