snegov/cura-te-ipsum
1
0 Fork 0
Code Issues 20 Releases Wiki Activity

No CHANGELOG.md to track version history #24

New Issue
Open
opened 2025-11-15 03:44:23 +00:00 by snegov · 0 comments
snegov commented 2025-11-15 03:44:23 +00:00
Owner
Copy link
Copy source

No CHANGELOG.md to track version history

Priority: Low
Component: Documentation
Type: Documentation

Description

The project lacks a CHANGELOG.md file to track changes between versions, making it hard for users to understand what changed and whether they should upgrade.

Why This Matters

  • Users can't see what changed between versions
  • Upgrading decisions are harder without knowing what's new/fixed
  • Standard practice in open-source projects
  • Helpful for debugging ("this worked in version X")

Proposed Solution

Add CHANGELOG.md following Keep a Changelog format:

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Configuration file support
- Progress indicators for large backups
- Backup statistics and metrics

### Changed
- Minimum Python version increased to 3.8
- Improved error handling in lock file management

### Fixed
- Race condition in lock file creation
- Permission update bug in rsync

## [0.1.0] - 2025-01-15

### Added
- Initial release
- Basic backup functionality
- Hardlink-based incremental backups
- Grandfather-father-son retention policy

Update with each release to track changes.

Impact

Low - Documentation improvement, doesn't affect functionality.

# No CHANGELOG.md to track version history **Priority:** Low **Component:** Documentation **Type:** Documentation ## Description The project lacks a CHANGELOG.md file to track changes between versions, making it hard for users to understand what changed and whether they should upgrade. ## Why This Matters - Users can't see what changed between versions - Upgrading decisions are harder without knowing what's new/fixed - Standard practice in open-source projects - Helpful for debugging ("this worked in version X") ## Proposed Solution Add `CHANGELOG.md` following [Keep a Changelog](https://keepachangelog.com/) format: ```markdown # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ### Added - Configuration file support - Progress indicators for large backups - Backup statistics and metrics ### Changed - Minimum Python version increased to 3.8 - Improved error handling in lock file management ### Fixed - Race condition in lock file creation - Permission update bug in rsync ## [0.1.0] - 2025-01-15 ### Added - Initial release - Basic backup functionality - Hardlink-based incremental backups - Grandfather-father-son retention policy ``` Update with each release to track changes. ## Impact **Low** - Documentation improvement, doesn't affect functionality.
Sign in to join this conversation.
No Branch/Tag Specified
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
snegov (Maks Snegov)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: snegov/cura-te-ipsum#24