mirror/rendercv
1
0
Fork 0
mirror of https://github.com/rendercv/rendercv.git synced 2025-12-23 21:47:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove pyright and pre-commit from developer guide and mention ty and prek instead

Browse Source
This commit is contained in:
Sina Atalay
2025-12-23 15:24:44 +03:00
parent 3360db357a
commit c61bba3c70
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/developer_guide/code_guidelines/source_code.md
View File

@@ -20,7 +20,7 @@ just format
just check
```
If there's absolutely no alternative, use `# pyright: ignore[errorCode]` or `#NOQA: errorCode` to ignore typing or linting errors.
If there's absolutely no alternative, use `# ty: ignore[error-code]` or `#NOQA: error-code` to ignore typing or linting errors.
## Docstrings

4
docs/developer_guide/index.md
View File

@@ -52,8 +52,8 @@ That's it! You're now ready to start developing RenderCV.
### Development
- `just sync`: Sync all dependencies (including extras and dev groups)
- `just format`: Format code with black and ruff
- `just check`: Run all checks (ruff, pyright, pre-commit)
- `just format`: Format code with `black` and `ruff`
- `just check`: Run all checks (`ruff`, `ty`, `pre-commit`)
- `just lock`: Update `uv.lock` file
### Testing

4
docs/developer_guide/project_management.md
View File

@@ -81,7 +81,7 @@ This file defines:
- Dependencies (what packages RenderCV needs)
- Entry points (makes `rendercv` a command)
- Build configuration (how to package RenderCV)
- Tool settings (`ruff`, `pyright`, `pytest`, etc.)
- Tool settings (`ruff`, `ty`, `pytest`, etc.)
Open the file to see the full configuration with detailed comments.
@@ -119,7 +119,7 @@ These scripts are called by `just` commands (`just update-schema`, `just update-
Configuration file for [`pre-commit`](https://pre-commit.com/), a tool that runs code quality checks.
**Why do we need it?** Pre-commit's value is **fast CI/CD**. [pre-commit.ci](https://pre-commit.ci/) (free for open-source projects) automatically checks if the source code has any `ruff` or `pyright` errors on every push and pull request. Forgot to format your code? The workflow fails, making it immediately obvious.
**Why do we need it?** Pre-commit's value is **fast CI/CD**. [pre-commit.ci](https://pre-commit.ci/) (free for open-source projects) automatically checks if the source code has any `ruff` or `ty` errors on every push and pull request. Forgot to format your code? The workflow fails, making it immediately obvious.
### [`uv.lock`](https://github.com/rendercv/rendercv/blob/main/uv.lock)