Skip to content

Commit 6f45266

Browse files
authored
docs: update README to improve structure and clarity
Reorganize contributing and code quality sections in README
1 parent deb6625 commit 6f45266

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -136,21 +136,17 @@ uv run pytest -v
136136
uv run pytest --cov=app --cov-report=html
137137
```
138138

139-
## Contributing
140-
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
141-
142-
### Install dev dependencies
143-
144-
With uv:
139+
## Code Quality
145140
```bash
141+
# Install linter
146142
uv sync --extra dev
147-
# Or
148-
uv pip install ".[dev]"
149-
```
150143

151-
### Run linting
152-
```bash
153-
uv run ruff check .
144+
# Linting
145+
uv ruff check app/
146+
147+
# Formatting
148+
uv ruff format app/
149+
```uff check .
154150
```
155151

156152
### Code style
@@ -161,6 +157,9 @@ This project follows:
161157
- Single Responsibility Principle
162158
- Dependency Injection pattern
163159

160+
## Contributing
161+
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
162+
164163
## License
165164
[GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.html)
166165

0 commit comments

Comments
 (0)