diff --git a/CHANGES.rst b/CHANGES.rst index ab3e7d2a..0f804326 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -16,6 +16,7 @@ In Development - Remove ``Registry`` from top level namespace. Closes :issue:`354`. - Fix: Normalization rules defined within the ``items`` rule are applied. (Evgeny Odegov) - Update homepage URL in package metadata. Closes :issue:`382`. +- Docs: add feature freeze note to CONTRIBUTING and note on Python support in README (Frank Sachsenheim). - Docs: add the intent of a ``dataclasses`` module to ROADMAP.md - Docs: update README link. Make it point to the new PYPI website. (Frank Sachsenheim) - Docs: improve documentation of the regex rule. Closes :issue:`389`. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9155a11e..b5f90a6b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,6 +6,12 @@ There are many ways to contribute to open source projects: reporting bugs, helping with the documentation, spreading the word and of course, adding new features and patches. +.. note:: + + There's currently a feature freeze until the basic code modernization for + the 2.0 release is finished. Have a look at the ``ROADMAP.md`` for a status + on its progress. + Getting Started --------------- #. Make sure you have a GitHub account. diff --git a/README.rst b/README.rst index 94e351c2..fbc4e59b 100644 --- a/README.rst +++ b/README.rst @@ -23,6 +23,9 @@ yours. Versioning & Interpreter support -------------------------------- +The Cerberus `1.x` versions can be used with Python 2 while version `2.0` and +later rely on Python 3 features. + Starting with Cerberus 1.2, it is maintained according to `semantical versioning`_. So, a major release sheds off the old and defines a space for the new, minor releases ship further new features and improvements diff --git a/ROADMAP.md b/ROADMAP.md index 08a2aa81..11d57faa 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -2,7 +2,6 @@ This document lays out a roadmap for the further development of Cerberus in the next few years, particularly in anticipation of the decay of Python 2. -The current status is a **draft**, pull requests for changes are welcome. ## Assumptions @@ -32,7 +31,7 @@ A *feature freeze* for functionality of the public API is declared. #### Checklist -- [ ] The `README.rst` and `CONTRIBUTING.rst` are updated accordingly. +- [x] The `README.rst` and `CONTRIBUTING.rst` are updated accordingly. - [ ] 1.3 is released. - [ ] 1.3.x branch is created. @@ -55,7 +54,10 @@ implications. - [ ] Objects from the `typing` module can be used as constraints for the `type` rule. (#374) - [ ] The `schema` rule only handles mappings, a new `itemrules` replaces the - part where `schema` tested items in sequences so far. (#tba) + part where `schema` tested items in sequences so far. There will be no + backward-compatibility for schemas. (#385) +- [ ] The rules `keyschema` and `valueschema` are renamed to `keyrules` and + `valuerules`, backward-compatibility for schemas will be provided. (#385) - [ ] Implementations of rules, coercers etc. can and the contributed should be qualified as such by metadata-annotating decorators. (With the intend to clean the code and make extensions simpler.) (#372)