From 8e5d789cea22cc267bafaf1bd8683de91e12e1d7 Mon Sep 17 00:00:00 2001 From: Oliver Sauder Date: Mon, 8 Mar 2021 22:09:07 +0400 Subject: [PATCH 1/4] Add security policy --- SECURITY.md | 9 +++++++++ docs/CONTRIBUTING.md | 12 ++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..c12d1c14 --- /dev/null +++ b/SECURITY.md @@ -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 [whatemailaddressshouldweuse@example.net][security-mail].The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. + +[security-mail]: mailto:rest-framework-security@googlegroups.com diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c3f7d0f1..3992eb76 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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 our: + +* [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) From 9ed2c9c2f13a427880f2f3639b9f09e02169c5c6 Mon Sep 17 00:00:00 2001 From: Oliver Sauder Date: Tue, 16 Mar 2021 23:55:57 +0400 Subject: [PATCH 2/4] Update SECURITY.md Replace invalid email address --- SECURITY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SECURITY.md b/SECURITY.md index c12d1c14..4d778f20 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,6 +4,6 @@ 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 [whatemailaddressshouldweuse@example.net][security-mail].The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. +Send a description of the issue via email to [rest-framework-security@googlegroups.com][security-mail].The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. [security-mail]: mailto:rest-framework-security@googlegroups.com From db3aacc7eece14eee588b2232ba1500ef3804444 Mon Sep 17 00:00:00 2001 From: Oliver Sauder Date: Tue, 16 Mar 2021 23:56:23 +0400 Subject: [PATCH 3/4] Update SECURITY.md Add missing space --- SECURITY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SECURITY.md b/SECURITY.md index 4d778f20..ef73aad3 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,6 +4,6 @@ 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 [rest-framework-security@googlegroups.com][security-mail].The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. +Send a description of the issue via email to [rest-framework-security@googlegroups.com][security-mail]. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. [security-mail]: mailto:rest-framework-security@googlegroups.com From c60dc372606d4b90b66ead20904e439807725c43 Mon Sep 17 00:00:00 2001 From: Oliver Sauder Date: Tue, 16 Mar 2021 23:58:38 +0400 Subject: [PATCH 4/4] Update CONTRIBUTING.md Clarify add maintainer description. --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3992eb76..be1d0499 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -64,7 +64,7 @@ To upload a release (using version 1.2.3 as the example) first setup testing env ### Add maintainer -In case a new maintainer joins our team we need to consider to what of following services we want to add them our: +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/)