Issue Templates and Security Policy (#2)

.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.

.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.

.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.

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

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 `[email protected]` 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.