Skip to content

Commit 18fbac6

Browse files
committed
chore: add and update cursor rules
1 parent d530311 commit 18fbac6

File tree

4 files changed

+60
-37
lines changed

4 files changed

+60
-37
lines changed

.cursor/rules/doc_rules.mdc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
description:
3+
globs: *.md
4+
alwaysApply: false
5+
---
6+
# Documentation rules
7+
8+
Write technical documentation in English. The documentation should be concise, precise, and easily understandable for non-native speakers. Use simple language and avoid complex academic terms. Adhere to professional technical writing standards and best practices.

.cursor/rules/general_rules.mdc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
description:
3+
globs:
4+
alwaysApply: true
5+
---
6+
# General coding rules
7+
8+
You use:
9+
10+
- Python 3.10
11+
- pydantic for data structures management and schemas
12+
- typer for CLI
13+
- jinja2 for templates
14+
- uv for dependency management
15+
- pytest for unit tests
16+
- poe for tasks management
17+
- ruff for code formatting
18+
- ruff for code linting
19+
- pyright for type checking
20+
- pre-commit for git hooks
21+
- mkdocs for documentation
22+
- mkdocs-material for documentation theme
23+
24+
Use `uv run` to execute any python code. Example:
25+
26+
```bash
27+
uv run pytest # run all tests
28+
uv run corsair --h # run corsair help
29+
```
30+
31+
Use `uv run poe <task>` to execute any maintenance tasks. Example:
32+
33+
```bash
34+
uv run poe format # format code with ruff
35+
uv run poe lint # check code with ruff
36+
uv run poe lint --fix # fix linting errors with ruff
37+
uv run poe check-format # check format with ruff
38+
uv run poe check-types # check types with pyright
39+
uv run poe test # run tests with pytest
40+
uv run poe test-cov # run tests with coverage
41+
```

.cursor/rules/git_rules.mdc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
description:
3+
globs:
4+
alwaysApply: true
5+
---
6+
# Git rules
7+
8+
For git commit messages follow the [Conventional Commits](mdc:https:/www.conventionalcommits.org) specification.
9+
10+
For git tags follow [Semantic Versioning (SemVer)](mdc:https:/semver.org).

.cursor/rules/python_rules.mdc

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description:
3-
globs: *.py,**/*.py
3+
globs: *.py
44
alwaysApply: false
55
---
66
# Python coding rules
@@ -27,39 +27,3 @@ You are an expert in Python and CLI tools development.
2727
- Do not switch to another test until the current one is passing
2828
- Use pytest verbosity arguments (-vv) to collect more information
2929

30-
## Used Tools
31-
32-
You use:
33-
34-
- Python 3.10
35-
- pydantic for data structures management and schemas
36-
- typer for CLI
37-
- jinja2 for templates
38-
- uv for dependency management
39-
- pytest for unit tests
40-
- poe for tasks management
41-
- ruff for code formatting
42-
- ruff for code linting
43-
- pyright for type checking
44-
- pre-commit for git hooks
45-
- mkdocs for documentation
46-
- mkdocs-material for documentation theme
47-
48-
Use `uv run` to execute any python code. Example:
49-
50-
```bash
51-
uv run pytest # run all tests
52-
uv run corsair --h # run corsair help
53-
```
54-
55-
Use `uv run poe <task>` to execute any maintenance tasks. Example:
56-
57-
```bash
58-
uv run poe format # format code with ruff
59-
uv run poe lint # check code with ruff
60-
uv run poe lint --fix # fix linting errors with ruff
61-
uv run poe check-format # check format with ruff
62-
uv run poe check-types # check types with pyright
63-
uv run poe test # run tests with pytest
64-
uv run poe test-cov # run tests with coverage
65-
```

0 commit comments

Comments
 (0)