Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update #79

Merged
merged 1 commit into from
Feb 8, 2025
Merged

docs: update #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 11 additions & 4 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,19 @@ asyncio
twisted
```

## Credits

```{include} ../README.md
:start-after: "## Credits\n"
```{toctree}
:hidden:
:caption: Meta

PyPI <https://pypi.org/project/prometheus-async/>
GitHub <https://github.com/hynek/prometheus-async/>
Changelog <https://github.com/hynek/prometheus-async/blob/main/CHANGELOG.md>
Contributing <https://github.com/hynek/prometheus-async/blob/main/.github/CONTRIBUTING.md>
Security Policy <https://github.com/hynek/prometheus-async/blob/main/.github/SECURITY.md>
Funding <https://hynek.me/say-thanks/>
```


## Indices and tables

- {ref}`genindex`
Expand Down