Skip to content

Commit a9a5975

Browse files
committed
vide coding / Use shared AI instruction files across multiple repositories
1 parent 8301f33 commit a9a5975

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/posts/2025/2025-08-31-vibe-coding-cheat-sheet.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ categories:
99
comments: true
1010
date:
1111
created: 2025-08-31
12-
updated: 2025-09-04
12+
updated: 2025-09-09
1313
---
1414

1515
# Vibe coding cheat sheet
@@ -52,6 +52,8 @@ Examples:
5252

5353
## Claude Code rules
5454

55+
[CLAUDE.md](https://www.anthropic.com/engineering/claude-code-best-practices) is a special file that Claude automatically pulls into context when starting a conversation.
56+
5557
Chris Dzombak's [claude code rules](https://www.dzombak.com/blog/2025/08/getting-good-results-from-claude-code/)
5658

5759
## Other instructions
@@ -65,8 +67,30 @@ Chris Dzombak's [claude code rules](https://www.dzombak.com/blog/2025/08/getting
6567

6668
- Write code in Python 3.13+ syntax.
6769
- Write clean, modern, elegant, maintainable, testable, high-performance, and production-quality code following established design patterns and best practices.
68-
- Use modern Python features, such as pathlib over os.path, asyncio over multithreading, pytest over unittest, polars over pandas, fastapi over flask, walrus, etc.
70+
- Use modern Python features, such as pathlib over os.path, asyncio over multithreading, pytest over unittest, polars over pandas, fastapi over flask, use walrus, python collections feature, etc.
6971
- Use pydantic v2 if you need data validation and settings management.
7072
- Use sqlalchemy v2 for database interactions.
7173
- Complex logic should be as less as possible in the code, but if it really needs to be there, give comments for explanation.
7274
- Typing is mandatory. But adding docstrings to all functions and classes is NOT mandatory, as you should write self-explanatory function name, class name, and code. But if you think it is necessary, DO add them.
75+
```
76+
77+
## Use shared AI instruction files across multiple repositories
78+
79+
You can create all the copilot claude instructions files in a folder say `~/.github`
80+
81+
Then you can create symlinks to the files in your project folder:
82+
83+
```bash
84+
cd /path/to/your/project
85+
86+
mkdir -p .github/instructions
87+
mkdir -p .github/prompts
88+
89+
ln -s ~/.github/copilot-instructions.md .github/copilot-instructions.md
90+
ln -s ~/.github/instructions/python.instructions.md .github/instructions/python.instructions.md
91+
ln -s ~/.github/prompts/python.prompt.md .github/prompts/python.prompt.md
92+
ln -s ~/.github/CLAUDE.md CLAUDE.md
93+
94+
echo ".github/**/*.md" >> .gitignore
95+
echo "CLAUDE.md" >> .gitignore
96+
```

0 commit comments

Comments
 (0)