Skip to content

Commit

Permalink
Create SECURITY.md (pydantic#1171)
Browse files Browse the repository at this point in the history
* Create SECURITY.md

* add link from docs and readme
  • Loading branch information
samuelcolvin authored Jan 17, 2020
1 parent e2533e0 commit a9e8db3
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
16 changes: 16 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Security Policy

## Supported Versions

We will endeavour to support:
* the most recent minor release with bug fixes
* the latest minor release from the last major version
for 6 months after a new major version is released with critical bug fixes
* all versions if a security vulnerability is found provided 1) upgrading to a later version is non-trivial 2)
sufficient people are using that version to make support worthwhile

## Reporting a Vulnerability

If you find what you think might be a security vulnerability with pydantic,
please do not create an issue on github. Instead please email s@muelcolvin.com
I'll reply to your email prompted and try to get a patch out ASAP.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ See [documentation](https://pydantic-docs.helpmanual.io/) for more details.
## Installation

Install using `pip install -U pydantic` or `conda install pydantic -c conda-forge`.
For more installation options to make *pydantic* even faster,
For more installation options to make *pydantic* even faster,
see the [Install](https://pydantic-docs.helpmanual.io/install/) section in the documentation.

## A Simple Example
Expand All @@ -47,5 +47,9 @@ print(user.id)
## Contributing

For guidance on setting up a development environment and how to make a
contribution to *pydantic*, see
contribution to *pydantic*, see
[Contributing to Pydantic](https://pydantic-docs.helpmanual.io/contributing/).

## Reporting a Security Vulnerability

See our [security policy](https://github.com/samuelcolvin/pydantic/security/policy).
3 changes: 2 additions & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ We'd love you to contribute to *pydantic*!

## Issues

Questions, feature requests and bug reports are all welcome as issues.
Questions, feature requests and bug reports are all welcome as issues. **However, to report a security
vulnerability, please see our [security policy](https://github.com/samuelcolvin/pydantic/security/policy).**

To make it as simple as possible for us to help you, please include the output of the following call in your issue:

Expand Down

0 comments on commit a9e8db3

Please sign in to comment.