From 6072636241f59714a21031d46c66b28031a363b2 Mon Sep 17 00:00:00 2001 From: Travis Fortney <4909047+travisfortney@users.noreply.github.com> Date: Fri, 16 Oct 2026 23:02:54 -0400 Subject: [PATCH] docs: correct README filename in contributor guide --- CONTRIBUTING.md | 2 +- HISTORY.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43ed5a8c..7f2724b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,7 +107,7 @@ Before you submit a pull request, check that it meets these guidelines: 2. The pull request should include tests. 3. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the - feature to the list in README.rst. + feature to the list in README.md. 4. The pull request should work for all supported Python versions. Check [https://github.com/python-attrs/cattrs/actions](https://github.com/python-attrs/cattrs/actions) and make sure that the tests pass for all supported Python versions. diff --git a/HISTORY.md b/HISTORY.md index a4464ea6..d777b096 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -13,6 +13,7 @@ Our backwards-compatibility policy can be found [here](https://github.com/python ## NEXT +- Correct the README filename in the contributor guide. - Dict unstructuring hook factories now inherit the converter's `omit_if_default` setting when `_cattrs_omit_if_default` is omitted. Explicit `True` or `False` values and per-attribute overrides retain their precedence. ([#238](https://github.com/python-attrs/cattrs/issues/238)) - Support the [`frozendict`](https://docs.python.org/3.15/builtins/stdtypes.html#frozendict) built-in on Python 3.15+.