From 9e7e0974b68055ccb4e4a4a48272631e27b38fcd Mon Sep 17 00:00:00 2001 From: Molly Moen Date: Fri, 6 Dec 2024 14:15:07 -0800 Subject: [PATCH] update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20007b3..3a35431 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,12 @@ This tests adds some customization to the output of unit tests, and has a functi ``` ## Building a package -From the package folder containing `pyproject.toml`, run `pipenv run python -m build`. The generated `.whl` file will be in the `dist` folder. +From the package folder containing `pyproject.toml`, run `python -m build`. The generated `.whl` file will be in the `dist` folder. ## Run tests From the folder containing code and tests, run `pipenv run python -m unittest`. This will look for tests in all files that start with `test`. -# Linting +# Lint your code We use [ruff](https://docs.astral.sh/ruff/installation/) for linting. It is a dev dependency of all of our packages. You can install it on your editor of choice for inline suggestions (for example, [VS Code](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)), and run it on the command line via `ruff check`. It also runs as part of the PR check process.