diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8da7db3..5eb7362 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,6 +8,7 @@ Fixes #___ ## Checklist -- [ ] Unit tests added or updated -- [ ] Documentation added or updated -- [ ] Updated CHANGELOG.md +- [ ] **Clear PR title** (used for generating release notes). + - Prefer using prefixes like `fix:` or `feat:` to help organize auto-generated notes. +- [ ] **Unit tests** added or updated. +- [ ] **Documentation** added or updated. diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 8e8559e..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,153 +0,0 @@ -## [v1.2.1](https://github.com/higlass/higlass-python/compare/v1.2.0...v1.2.1) - -- Calculate file pointer hash for track uids for tileset tracks -- Fix view copy behavior to preserve specific plugin track class vars - -## [v1.2.0](https://github.com/higlass/higlass-python/compare/v1.1.2...v1.2.0) - -- **Breaking**: Migrate to higlass-schema v0.2.0 (pydantic v2) -- Shorter automatic uids for Tracks and Views -- Upgrade HiGlass front-end to v1.13 - -This release does not introduce changes to the `higlass-python` API itself. However, it migrates the core data objects created and modified by the `higlass-python` API from Pydantic v1 to Pydantic v2. We are marking this as a **breaking release**, as some methods and attributes on these objects are now deprecated. - -Libraries relying on `higlass-schema` (Pydantic models for Python) may encounter breaking changes if they use methods that have changed between Pydantic v1 and v2. We expect this update to improve compatibility and make it easier to use `higlass-python` in environments that depend on Pydantic v2 (which are increasing). - -## [v1.1.2](https://github.com/higlass/higlass-python/compare/v1.1.1...v1.1.2) - -- Pin higlass-schema version upper bound for