https://github.com/y-scope/yscope-dev-utils
A collection of configs, scripts, and tools that are reusable across YScope repos.
https://github.com/y-scope/yscope-dev-utils
Last synced: 5 months ago
JSON representation
A collection of configs, scripts, and tools that are reusable across YScope repos.
- Host: GitHub
- URL: https://github.com/y-scope/yscope-dev-utils
- Owner: y-scope
- License: apache-2.0
- Created: 2024-06-22T10:19:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-26T13:42:04.000Z (7 months ago)
- Last Synced: 2025-11-29T11:43:21.996Z (7 months ago)
- Language: C++
- Size: 112 KB
- Stars: 3
- Watchers: 4
- Forks: 9
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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:
* [coreutils]\: `md5sum`
* [gnu-tar]\: `gtar`
## Testing
To run all tests:
```bash
task test
```
You can also run specific unit tests with `task tests:`, where `` is the name of the
test you want to run.
## Linting
To run all linting checks:
```bash
task lint:check
```
You can also run specific linting checks with `task lint:`, where `` is the name of
check you want to run.
## Cleaning
To clean up any generated files:
```bash
task clean
```
[coreutils]: https://formulae.brew.sh/formula/coreutils
[gnu-tar]: https://formulae.brew.sh/formula/gnu-tar
[Task]: https://taskfile.dev/
[uv]: https://docs.astral.sh/uv