Skip to content

Commit ea0bcea

Browse files
committed
README.md...
1 parent 00b5d8a commit ea0bcea

1 file changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,12 @@ make test
115115

116116
```bash
117117
make help # Show all available commands
118-
make format # Format code with black and ruff
119-
make lint # Check code style
120-
make type-check # Check types with mypy
118+
make format # Format code with black and isort
121119
make test # Run tests
122-
make check-all # Run all checks
120+
make check # Run format and tests
121+
make install # Install dependencies
122+
make update # Update dependencies
123+
make clean # Clean up generated files
123124
```
124125

125126
### Project Structure
@@ -132,27 +133,34 @@ make check-all # Run all checks
132133
│ ├── handler.py # Command handler
133134
│ ├── decorators.py # Command decorators
134135
│ ├── config.py # Configuration and logging
135-
│ └── classes/ # Types and enums
136-
│ ├── command.py
137-
│ ├── menu.py
138-
│ ├── types.py
139-
│ └── enums.py
136+
│ ├── protocols.py # Protocol definitions
137+
│ ├── classes/ # Types and enums
138+
│ │ ├── command.py
139+
│ │ ├── menu.py
140+
│ │ ├── types.py
141+
│ │ └── enums.py
142+
│ └── tools/ # Utility tools
143+
│ └── logger.py # Logging utilities
140144
├── tests/ # Unit tests
141145
│ ├── test_bot.py
142146
│ ├── test_handler.py
143147
│ └── handlers/ # Handler examples
144148
├── pyproject.toml # Project configuration
145149
├── Makefile # Development commands
150+
├── requirements.txt # Production dependencies
151+
├── requirements-dev.txt # Development dependencies
152+
├── setup.py # Setup configuration
146153
└── .pre-commit-config.yaml # Pre-commit hooks
147154
```
148155

149156
## 📝 Code Conventions
150157

151-
- **Style**: Black (max line: 120 characters)
152-
- **Linting**: Ruff
158+
- **Style**: Black (max line: 120 characters) + isort
159+
- **Linting**: Ruff + Flake8 (in pre-commit)
153160
- **Type checking**: Mypy with strict mode
154161
- **Docstrings**: Google format
155162
- **Tests**: Pytest
163+
- **Pre-commit hooks**: Multiple quality checks including security (bandit), spell checking (codespell), and more
156164

157165
## 🤝 Contributing
158166

@@ -165,8 +173,8 @@ make check-all # Run all checks
165173
### Before Submitting
166174

167175
```bash
168-
make check-all # Check everything
169-
make pre-commit # Run pre-commit
176+
make check # Run format and tests
177+
pre-commit run --all-files # Run all pre-commit hooks
170178
```
171179

172180
## 📄 License

0 commit comments

Comments
 (0)