Skip to content

Commit e850d77

Browse files
committed
Makefile + updated README
1 parent 09e2825 commit e850d77

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ install:
2020
poetry install
2121

2222
lint:
23-
poetry run flake8 . --max-line-length=120 --exclude=.venv,.git,__pycache__
23+
poetry run flake8 .
2424

2525
format:
2626
poetry run isort .

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ This repository is a modular and efficient framework designed to manage and solv
7777

7878
```hcl
7979
.
80+
├── .github
81+
│ └── workflows
82+
│ └── python-ci.yml
8083
├── aoc
8184
│ ├── __init__.py
8285
│ ├── models
@@ -103,6 +106,7 @@ This repository is a modular and efficient framework designed to manage and solv
103106
│ └── test_02.py # Tests for Day 2 solutions
104107
├── .gitignore
105108
├── main.py # Main script to manage tasks and run solutions
109+
├── Makefile
106110
├── poetry.lock
107111
├── pyproject.toml
108112
└── README.md
@@ -139,6 +143,21 @@ The central script to perform various tasks such as:
139143
- Benchmarking solution performance.
140144
- Submitting answers directly to the Advent of Code website.
141145

146+
#### `Makefile`
147+
148+
Provides convenient commands for common development tasks:
149+
- Installing dependencies
150+
- Running code quality checks (black, isort, flake8)
151+
- Executing tests
152+
- Formatting code
153+
154+
#### `.github/workflows/python-ci.yml`
155+
156+
GitHub Actions workflow configuration that automates:
157+
- Code quality checks on every push and pull request
158+
- Test execution after successful linting
159+
- Dependency caching for faster builds
160+
142161
## Usage
143162

144163
```bash

0 commit comments

Comments
 (0)