From 0c63c62e04cdd9e53b5dfb67039b05258b420a00 Mon Sep 17 00:00:00 2001 From: Pradeep Tammali Date: Tue, 3 Mar 2026 01:31:07 +0100 Subject: [PATCH] docs: update the changelog --- .pre-commit-config.yaml | 9 ++++++++- CHANGELOG.md | 23 ++++++++++++++++++++++- pyproject.toml | 4 ++++ 3 files changed, 34 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ccd668b..74a7782 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,5 +52,12 @@ repos: rev: v0.47.0 hooks: - id: markdownlint - args: [--fix] + args: + [ + "--config", + "pyproject.toml", + "--configPointer", + "/tool/markdownlint", + "--fix", + ] types: [markdown] diff --git a/CHANGELOG.md b/CHANGELOG.md index a543958..f588da9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,28 @@ 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.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [1.0.0] - 2026-03-02 + +### Added + +- Production/stable release (1.0.0). + +## [0.1.1] - 2026-03-01 + +### Added + +- PEP 561 marker (`py.typed`) for type-checker support when using the package as a dependency. +- Domain policy record utilities in `utils` (shared parsing for SPF/DMARC-style records). +- Burner-email-providers reference in documentation. + +### Changed + +- Public API documentation updated for SemVer (README). +- Domain policy record handling: shared utils; redundant match checks removed in SPF/DMARC/DKIM. + +### Fixed + +- Exception when a domain has no nameservers; validation no longer crashes and returns a proper result. ## [0.1.0] - 2026-02-26 diff --git a/pyproject.toml b/pyproject.toml index 6721acf..7be9807 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,3 +55,7 @@ warn_unused_ignores = true [tool.pytest.ini_options] testpaths = ["tests"] + +[tool.markdownlint] +MD013 = { line_length = 120 } +MD024 = { siblings_only = true }