From 7ea3458a78de6e184e5ee3b6ed3cccaacd803e5e Mon Sep 17 00:00:00 2001 From: Caleb Herbel Date: Fri, 28 Jul 2023 12:22:58 -0700 Subject: [PATCH] Issue Templates and Security Policy (#2) --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++ .../documentation-issue-report.md | 27 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ CONTRIBUTING.md | 6 ++-- SECURITY.md | 24 ++++++++++++++ 5 files changed, 106 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-issue-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9d84140 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[A Few Words Describing the Bug]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Use arguments '...' +2. With model '....' +3. See error '...' + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS [e.g. macOS 13.4 (ARM)] + - Modelscan Version [e.g. v1.0.0] + - ML Framework version [e.g. Tensorflow v2.13.0] (if applicable) + - Describe the model serialization format that triggered this error (if applicable) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation-issue-report.md b/.github/ISSUE_TEMPLATE/documentation-issue-report.md new file mode 100644 index 0000000..9ff8cf5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-issue-report.md @@ -0,0 +1,27 @@ +--- +name: Documentation issue report +about: Create a report to help us improve our documentation +title: "[A Few Words Describing the Issue]" +labels: bug, documentation +assignees: '' + +--- + +**Describe the issue** +A clear and concise description of what the issue is. + +**Relevant page** +Link the page that should be addressed + +**Expected behavior/text** +A clear and concise description of what you expected to see in the documentation. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Modelscan Version [e.g. v1.0.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bca7c21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for modelscan +title: "[A Few Words Describing the Feature]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b9f0dd..e30fbd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # 👩‍💻 CONTRIBUTING -Welcome! We're glad to have you. If you would like to report a bug, request a new feature or enhancement, follow [this link](to-be-updated-in-new-repo) for more help. +Welcome! We're glad to have you. If you would like to report a bug, request a new feature or enhancement, follow [this link](https://github.com/protectai/modelscan/issues/new/choose). ## ❗️ Requirements 1. Python - `modelscan` requires python version `>=3.8` and `<4.0` + `modelscan` requires python version `>=3.8` and `<3.11` 2. Poetry @@ -31,7 +31,7 @@ Welcome! We're glad to have you. If you would like to report a bug, request a ne Run a scan with the cli with the following command: ```bash - modelscan --huggingface ykilcher/totally-harmless-model + modelscan -p /path/to/file ``` ## 📝 Submitting Changes diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..109ee97 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,24 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 1.x | :white_check_mark: | + +## Reporting a Vulnerability + +If you find a vulnerability in modelscan, perform the following steps: + +1. [Open an issue](https://github.com/protectai/modelscan/issues/new?assignees=&labels=bug&template=bug_report.md&title=[BUG]%20Security%20Vulnerability) in the modelscan repo. Use `[BUG] Security Vulnerability` as the title and do not include any vulnerability details in the issue description. +2. Send us an email at `security@protectai.com` with the following: + - The link to the issue you created above. + - Your GitHub handle. + - Details about the vulnerability including: + - A description of what the vulnerability is. + - Evidence of the issue happening or references to the relevant lines of code. + - Instructions to reproduce the issue. + +After we have reproduced the issue we will reply to the issue and [open a draft security advisory](https://docs.github.com/en/code-security/security-advisories/creating-a-security-advisory) and will discuss the details there. + +Once we've released a fix we will use the Security Advisory to announce the findings.