Skip to content

Commit f6ffb29

Browse files
committed
Update CHANGELOG with new development container setup and enhanced README badges
1 parent 73353b5 commit f6ffb29

2 files changed

Lines changed: 41 additions & 1 deletion

File tree

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,8 @@ cython_debug/
163163
#.idea/
164164

165165
# poetry
166-
poetry.lock
166+
poetry.lock
167+
168+
# diff files
169+
*.diff
170+
diff*

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,42 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased]
9+
10+
### Added
11+
12+
#### `.devcontainer/devcontainer.json`
13+
- Introduced a new Visual Studio Code **development container** configuration to streamline the development environment.
14+
- Uses the base Ubuntu image from Microsoft's devcontainers.
15+
- Adds common development utilities via `common-utils` feature.
16+
- Installs VS Code extensions:
17+
- `elagil.pre-commit-helper`
18+
- `ms-python.python`
19+
- Runs `.devcontainer/setup.sh` post container creation for environment setup.
20+
21+
#### `.devcontainer/setup.sh`
22+
- Added a setup script for the development container:
23+
- Installs **Poetry** package manager.
24+
- Installs all project dependencies, including development dependencies.
25+
- Activates the Poetry virtual environment and opens a shell.
26+
- Installs **pre-commit hooks** for code quality enforcement.
27+
28+
### Changed
29+
30+
#### `Contributing.md`
31+
- Updated instructions for activating the Poetry virtual environment:
32+
- Changed from `poetry shell` to `eval $(poetry env activate)` for improved shell compatibility and automation.
33+
34+
#### `README.md`
35+
- Added badges to the top of the README for enhanced project visibility:
36+
- **PyPI version** badge.
37+
- **PyPI downloads** badge.
38+
- **GPL v3 License** badge.
39+
40+
#### `pyproject.toml`
41+
- Added new dependency:
42+
- `shell` package (`^1.0.1`) for enhanced shell scripting and command execution capabilities within the project.
43+
844
## [0.6.0] - 2025-02-24
945

1046
### Changed

0 commit comments

Comments
 (0)