Copilot Instructions

General Guidelines

Language and Documentation

ALL code documentation MUST be in English (docstrings, comments, variable names, function names)
ALL commit messages MUST be in English
Use clear, descriptive naming conventions following PEP 8
Every function/class must have a comprehensive docstring

Code Quality Standards

Maximum file length: 200 lines (excluding docstrings and comments)
If a file exceeds 200 lines, split it into multiple modules
Follow SOLID principles and keep functions focused on single responsibilities
Use type hints for all function signatures

File Operations - CRITICAL RULES

⚠️ NEVER create, modify, or delete ANY file without explicit user approval

Always ask before creating new files
Always ask before modifying existing files
Always ask before deleting files
Show the user what changes you intend to make first

Project Structure

ROOT/
├── src/           # Source code modules
├── scripts/       # Executable scripts
├── pyproject.toml # Poetry dependencies
└── README.md      # Project documentation

Workflow

Always start by understanding the requirements
Plan the architecture before coding
Document as you code
Ask for approval before making file changes
Commit small, logical changes with descriptive messages

Python Style Guide

Follow PEP 8
Use Black formatter (line length: 88)
Use isort for import sorting
Use pylint/flake8 for linting
Maximum function complexity: 10 (cyclomatic complexity)

Error Handling

Use specific exception types
Always log errors with full context
Provide helpful error messages to users
Fail gracefully with meaningful feedback

Performance Guidelines

Profile code when processing large datasets
Use generators for memory efficiency
Parallelize when beneficial (multiprocessing/threading)
Cache expensive computations when appropriate

Security

Never commit sensitive data
Sanitize user inputs
Use secure random for any cryptographic needs
Keep dependencies updated

Version Control

Commit frequently with meaningful messages
Use conventional commit format:
```
type(scope): description
```
- Types: feat, fix, docs, style, refactor, test, chore
Keep commits atomic and focused
Branch for features/experiments

Sprint Workflow

Each sprint gets a dedicated branch:

sprint-N/description

Example:
```
sprint-1/config-and-utilities
```

Create branch from
```
master
```
before starting sprint work
Make all sprint commits on the sprint branch
Request user approval before merging to master
Delete sprint branch after successful merge
Never push directly to master without approval

Remember: Quality over speed. Ask questions when requirements are unclear.

General Guidelines

ALL code documentation MUST be in English (docstrings, comments, variable names, function names)

ALL commit messages MUST be in English

Use clear, descriptive naming conventions following PEP 8

Every function/class must have a comprehensive docstring

Maximum file length: 200 lines (excluding docstrings and comments)

If a file exceeds 200 lines, split it into multiple modules

Follow SOLID principles and keep functions focused on single responsibilities

Use type hints for all function signatures

⚠️ NEVER create, modify, or delete ANY file without explicit user approval

Always ask before creating new files

Always ask before modifying existing files

Always ask before deleting files

Show the user what changes you intend to make first

Version Control

Commit frequently with meaningful messages

Use conventional commit format:

type(scope): description

Types: feat, fix, docs, style, refactor, test, chore

Keep commits atomic and focused

Branch for features/experiments

Each sprint gets a dedicated branch:

sprint-N/description

Example:
```
sprint-1/config-and-utilities
```

Create branch from

master

before starting sprint work

Make all sprint commits on the sprint branch

Request user approval before merging to master

Delete sprint branch after successful merge

Never push directly to master without approval

Remember: Quality over speed. Ask questions when requirements are unclear.

Copilot Instructions

Copilot Instructions

General Guidelines

Language and Documentation

Code Quality Standards

File Operations - CRITICAL RULES

Project Structure

Workflow

Python Style Guide

Error Handling

Performance Guidelines

Security

Version Control

Sprint Workflow

Related Skills

Markdown Converter

Nano Banana Pro

1password

Copilot Instructions

General Guidelines

Language and Documentation

Code Quality Standards

File Operations - CRITICAL RULES

Project Structure

Workflow

Python Style Guide

Error Handling

Performance Guidelines

Security

Version Control

Sprint Workflow