Skip to content

Create security policy #893

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.

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

Merged
merged 5 commits into from
Mar 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Reporting a Vulnerability

If you believe you've found something in Django REST Framework JSON API which has security implications, please **do not raise the issue in a public forum**.

Send a description of the issue via email to [[email protected]][security-mail]. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.

[security-mail]: mailto:[email protected]
12 changes: 12 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,21 @@ To setup pre-commit hooks first create a testing environment as explained above

## For maintainers

### Create release

To upload a release (using version 1.2.3 as the example) first setup testing environment as above before running below commands:

python setup.py sdist bdist_wheel
twine upload dist/*
git tag -a v1.2.3 -m 'Release 1.2.3'
git push --tags


### Add maintainer

In case a new maintainer joins our team we need to consider to what of following services we want to add them too:

* [Github organization](https://github.com/django-json-api)
* [Read the Docs project](https://django-rest-framework-json-api.readthedocs.io/)
* [PyPi project](https://pypi.org/project/djangorestframework-jsonapi/)
* [Google Groups security mailing list](https://groups.google.com/g/rest-framework-jsonapi-security)