Skip to content

Commit e32ff43

Browse files
authored
Create security policy (#893)
* Add security policy * Update SECURITY.md Replace invalid email address * Update SECURITY.md Add missing space * Update CONTRIBUTING.md Clarify add maintainer description.
1 parent 1444a67 commit e32ff43

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

SECURITY.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
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**.
6+
7+
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.
8+
9+
[security-mail]: mailto:[email protected]

docs/CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,21 @@ To setup pre-commit hooks first create a testing environment as explained above
5252

5353
## For maintainers
5454

55+
### Create release
56+
5557
To upload a release (using version 1.2.3 as the example) first setup testing environment as above before running below commands:
5658

5759
python setup.py sdist bdist_wheel
5860
twine upload dist/*
5961
git tag -a v1.2.3 -m 'Release 1.2.3'
6062
git push --tags
63+
64+
65+
### Add maintainer
66+
67+
In case a new maintainer joins our team we need to consider to what of following services we want to add them too:
68+
69+
* [Github organization](https://github.com/django-json-api)
70+
* [Read the Docs project](https://django-rest-framework-json-api.readthedocs.io/)
71+
* [PyPi project](https://pypi.org/project/djangorestframework-jsonapi/)
72+
* [Google Groups security mailing list](https://groups.google.com/g/rest-framework-jsonapi-security)

0 commit comments

Comments
 (0)