Skip to content

README.md

Latest commit

 

History

History
65 lines (42 loc) · 1.37 KB

README.md

File metadata and controls

65 lines (42 loc) · 1.37 KB

dev-utils

A collection of configurations, scripts, and tools that are reusable across YScope repositories.

Linting configuration versions

Contributing

Before you submit a pull request, ensure you follow the testing and linting instructions below.

Note

We use Task to automate our development workflow. You can use task --list-all to see all available tasks.

Requirements

  • Python 3.10 or higher
  • Task 3.40 or higher
  • uv 0.7.10 or higher

macOS

The exported tasks use GNU utilities that are not always pre-installed on macOS. You may need to install the following brew packages and add their executables to your PATH:

Testing

To run all tests:

task test

You can also run specific unit tests with task tests:<test>, where <test> is the name of the test you want to run.

Linting

To run all linting checks:

task lint:check

You can also run specific linting checks with task lint:<check>, where <check> is the name of check you want to run.

Cleaning

To clean up any generated files:

task clean