diff --git a/.github/SECURITY.md b/.github/SECURITY.md index e064e4a..500b769 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,11 +2,14 @@ ## Supported Versions -We are following [CalVer](https://calver.org) with generous backward-compatibility guarantees. +We are following [Calendar Versioning](https://calver.org) with generous backwards-compatibility guarantees. Therefore we only support the latest version. +Put simply, you shouldn't ever be afraid to upgrade as long as you're only using our public APIs. +Whenever there is a need to break compatibility, it is announced in the changelog, and raises a `DeprecationWarning` for a year (if possible) before it's finally really broken. -## Security contact information + +## Reporting a Vulnerability To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. diff --git a/docs/index.md b/docs/index.md index 5d8695c..cc26495 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,12 +18,19 @@ asyncio twisted ``` -## Credits - -```{include} ../README.md -:start-after: "## Credits\n" +```{toctree} +:hidden: +:caption: Meta + +PyPI +GitHub +Changelog +Contributing +Security Policy +Funding ``` + ## Indices and tables - {ref}`genindex`