Adds additional GitHub templates. Updates requirements on docs. Adds …

…coverage config file to ignore files covered by integration tests. (#8)

* Adds additional GitHub templates.
* Updates requirements on readme and contributing docs.
* Adds coverage config file to ignore files covered by integration tests.

.coveragerc

@@ -0,0 +1,10 @@
+[run]
+omit =
+    */__init__.py
+    src/advisor/reports/dependencies_report.py
+    src/advisor/reports/html_report.py
+    src/advisor/scanners/auto_scanner.py
+    src/advisor/scanners/scanner.py
+    src/advisor/scanners/scanners.py
+    src/advisor/main.py
+    src/porting-advisor.py

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Steps to Reproduce
+Steps to reproduce the behavior:
+1. Run with parameters '...'
+2. Open report...
+3. Scroll down to '...'
+4. See error
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Desktop (please complete the following information)
+ - OS: [e.g. Windows, macOS, Linux, etc]
+ - Version/Distro: [e.g. 11, Big Sur, Ubuntu 18.04]
+ - Processor Architecture: [e.g. x86/x64, ARM]
+ - Python Version:
+ - Java Version (if applicable):
+
+### Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+A clear and concise description of what the problem is.
+
+## Solution idea(s)
+A clear and concise description of what you want to happen.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/other_issue.md

@@ -0,0 +1,14 @@
+---
+name: Other issues
+about: Not a bug or feature request? Let us know how else we can improve.
+title: "[Other Issue]"
+labels: ''
+assignees: ''
+
+---
+
+## Description of issue
+Describe the issue
+
+## Additional context
+Provide any additional information

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+#### Description of change
+[//]: # (What are you trying to fix? What did you change)
+
+#### Issue
+[//]: # (Having an issue # for the PR is required for tracking purposes. If an existing issue does not exist please create one.)
+
+#### PR reviewer notes
+[//]: # (Let us know if there is anything we should focus on.)
+
+
+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

CONTRIBUTING.md

@@ -63,9 +63,7 @@ See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to
 ## Development setup
 
 ### Pre-requisites
-- Python 3.10.
-- PIP 3.
-- Python venv module.
+- Python 3.10 or above (with PIP3 and venv module installed).
 - (Optionally) Open JDK 17 (or above) and Maven 3.5 (or above) if you need to work with [Graviton Ready for Java](src/advisor/tools/graviton-ready-java/README.md) which enables you to scan JAR files for native methods.
 
 ### Working with Python virtual enviroment

README.md

@@ -47,7 +47,7 @@ If you run into any issues, see our [CONTRIBUTING](CONTRIBUTING.md#reporting-bug
 
 **Pre-requisites**
 
-- Python 3.10 or above.
+- Python 3.10 or above (with PIP3 and venv module installed).
 - (Optionally) Open JDK 17 (or above) and Maven 3.5 (or above) if you want to scan JAR files for native methods.
 
 **Enable Python Environment**
@@ -85,9 +85,7 @@ $. python3 src/porting-advisor.py ~/my/path/to/my/repo --output report.html
 
 **Pre-requisites**
 
-- Python 3.10 or above.
-- PIP 3.
-- Python venv module.
+- Python 3.10 or above (with PIP3 and venv module installed).
 - (Optionally) Open JDK 17 (or above) and Maven 3.5 (or above) if you want the binary to be able to scan JAR files for native methods.
 
 The `build.sh` script will generate a self-contained binary (for Linux/MacOS). It will be output to a folder called `dist`.
@@ -118,7 +116,7 @@ Generating HTML report:
 $ ./porting-advisor-linux-x86_64 ~/my/path/to/my/repo --output report.html
 ```
 
-Generating a report of just dependencies:
+Generating a report of just dependencies (this creates an Excel file with just the dependencies we found on the repo, no suggestions provided):
 ```
 $ ./porting-advisor-linux-x86_64 ~/my/path/to/my/repo --output dependencies.xlsx --output-format dependencies
 ```