From d3007607990068aea3ffa6b2665386f10cef82ae Mon Sep 17 00:00:00 2001 From: Xi Xu Date: Mon, 2 Jun 2025 21:39:24 +0800 Subject: [PATCH] Remove references to changelog and delete file Removed all references to `CHANGELOG.md` in documentation and templates, and deleted the `docs/changelog.md` file. This change reflects a shift away from maintaining a changelog in favor of other documentation practices. --- .github/PULL_REQUEST_TEMPLATE.md | 1 - CONTRIBUTING.md | 6 ++-- docs/README.md | 1 - docs/changelog.md | 50 -------------------------------- pyproject.toml | 1 - 5 files changed, 2 insertions(+), 57 deletions(-) delete mode 100644 docs/changelog.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 87e74d1..9d48912 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -88,7 +88,6 @@ assignees: '' - [ ] README.md updated (if needed) -- [ ] CHANGELOG.md updated (for user-facing changes) - [ ] Code comments added for complex logic - [ ] Docstrings updated for modified functions/classes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 824bbbe..745427e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -294,7 +294,6 @@ def create_archive( - **Fill out the PR template** completely - **Link related issues** using keywords (fixes #123) - **Keep PRs focused** - one feature/fix per PR -- **Update CHANGELOG.md** for user-facing changes - **Ensure all CI checks pass** - **Respond to review feedback** promptly @@ -310,9 +309,8 @@ def create_archive( Releases are handled by maintainers: 1. Update version in `src/tzst/__init__.py` -2. Update `CHANGELOG.md` -3. Create a release tag -4. Automated CI/CD publishes to PyPI +2. Create a release tag +3. Automated CI/CD publishes to PyPI ## Getting Help diff --git a/docs/README.md b/docs/README.md index 977154d..9167b8e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -69,7 +69,6 @@ make clean - `index.md` - Main documentation homepage - `quickstart.md` - Quick start guide for new users - `examples.md` - Practical examples and use cases -- `changelog.md` - Project changelog - `api/` - API reference documentation - `index.md` - API overview - `core.md` - Core functionality documentation diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index a3b9938..0000000 --- a/docs/changelog.md +++ /dev/null @@ -1,50 +0,0 @@ -# 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). - -## [1.1.0] - 2025-06-02 - -### Added - -- Comprehensive Sphinx documentation with automated GitHub Pages deployment -- API documentation with autodoc integration -- Quickstart guide and examples -- Performance benchmarking examples -- Security-focused extraction examples - -### Changed - -- Enhanced documentation structure -- Improved code examples and usage patterns - -### Documentation - -- Added complete API reference -- Added practical examples for common use cases -- Added security best practices guide -- Added performance optimization tips - -## [1.0.0] - Previous Release - -### Added - -- Initial release of tzst library -- TzstArchive class for archive management -- Convenience functions for common operations -- Command-line interface -- Streaming support for large archives -- Security filters for safe extraction -- Atomic operations for data integrity -- Comprehensive test suite - -### Features - -- Support for .tzst/.tar.zst archives -- Zstandard compression with configurable levels -- Memory-efficient streaming mode -- Built-in security protections -- Cross-platform compatibility -- Python 3.12+ support diff --git a/pyproject.toml b/pyproject.toml index 20a6f62..7dea3a2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -47,7 +47,6 @@ include = [ "tests", "README.md", "LICENSE", - "CHANGELOG.md", "CONTRIBUTING.md", ]