diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..83cae87d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,31 @@ +# Security policy + +## Reporting a vulnerability + +Please do not report security vulnerabilities in public GitHub issues, +discussions or pull requests. + +Instead, report them privately using GitHub's private vulnerability +reporting: + +1. Go to + (or open the **Security** tab of the repository and click + **Report a vulnerability**). +2. Describe the problem, the versions affected, and the steps needed to + reproduce it. A small example file or script is very helpful. + +The report is visible only to you and the maintainers. If you cannot use +GitHub's private reporting, email the maintainer, Simon Billinge +(sbillinge@ucsb.edu), and ask for a private channel before sending any +details. + +## What to expect + +We will acknowledge the report, investigate it, and keep you informed in +the private advisory. Once a fix is released we will publish the advisory +and credit you, unless you prefer to remain anonymous. + +## Supported versions + +Security fixes are made to the latest release of `diffpy.structure`. +Please upgrade to the latest release before reporting a problem. diff --git a/news/security-policy.rst b/news/security-policy.rst new file mode 100644 index 00000000..cc4c293e --- /dev/null +++ b/news/security-policy.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news needed: SECURITY.md is repository policy and not user facing + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*