chore(documentation): add mkdoc markdown, add issue templates and sec… (

#75)

* chore(documentation): add mkdoc markdown, add issue templates and security policy
* chore(documentation): update lume presentation
* fix(static-analysis): solve mypy warning

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,88 @@
+name: Bug
+description: Ask about a problem
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The `lume 🔥` community is glad to see you here. Your help is greatly appreciated.
+        
+        Please follow these instructions, fill every question, and do every step. 🙏
+        
+        This will help lume 🔥` community to add new features, fix bug, review pull requests, etc.
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: First Check
+      description: Please confirm and check all the following options.
+      options:
+        - label: I added a very descriptive title to this issue.
+          required: true
+        - label: I used the GitHub search to find a similar issue and didn't find it.
+          required: true
+        - label: I already read and followed all the [documentation](https://alice-biometrics.github.io/lume/) and didn't find an answer.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        What is the problem, question, or error?
+
+        Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
+      placeholder: |
+        * I expected a behavior using an installation step but I got ... whatever..
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you on?
+      multiple: true
+      options:
+        - Linux
+        - Windows
+        - macOS
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Operating System Details
+      description: You can add more details about your operating system here, in particular if you chose "Other".
+  - type: input
+    id: lume-version
+    attributes:
+      label: lume Version
+      description: |
+        What lume version are you using?
+
+        You can find the lume version with:
+
+        ```bash
+        >> lume --version
+        ```
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: |
+        What Python version are you using?
+
+        You can find the Python version with:
+
+        ```bash
+        python --version
+        ```
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any additional context information or screenshots you think are useful.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security Contact
+    about: Please report security vulnerabilities to security@alicebiometrics.com

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,106 @@
+name: Feature Request
+description: Suggest an idea or ask for a feature that you would like to have in lume.
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The `lume 🔥` community is glad to see you here. Your help is greatly appreciated.
+        
+        Please follow these instructions, fill every question, and do every step. 🙏
+        
+        This will help lume 🔥` community to add new features, fix bug, review pull requests, etc.
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: First Check
+      description: Please confirm and check all the following options.
+      options:
+        - label: I added a very descriptive title to this issue.
+          required: true
+        - label: I used the GitHub search to find a similar issue and didn't find it.
+          required: true
+        - label: I already read and followed all the [documentation](https://alice-biometrics.github.io/lume/) and didn't find an answer.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        What is your feature request?
+
+        Write a short description telling me what you are trying to solve and what you are currently doing.
+      placeholder: |
+        * I would like to define env variables using ....
+    validations:
+      required: true
+  - type: textarea
+    id: wanted-solution
+    attributes:
+      label: Wanted Solution
+      description: |
+        Tell us what's the solution you would like.
+      placeholder: |
+        I want new pre-build step to...
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: |
+        Tell me about alternatives you've considered.
+      placeholder: |
+        Define a whatever that help on your feature request.
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you on?
+      multiple: true
+      options:
+        - Linux
+        - Windows
+        - macOS
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Operating System Details
+      description: You can add more details about your operating system here, in particular if you chose "Other".
+  - type: input
+    id: lume-version
+    attributes:
+      label: lume Version
+      description: |
+        What lume version are you using?
+
+        You can find the lume version with:
+
+        ```bash
+        >> lume --version
+        ```
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: |
+        What Python version are you using?
+
+        You can find the Python version with:
+
+        ```bash
+        python --version
+        ```
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any additional context information or screenshots you think are useful.

.github/SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Supported Versions
+We will support latest version of the library.
+
+## Reporting a Vulnerability
+
+If you find what you think might be a security vulnerability with meiga,
+please do not create an issue on GitHub. Instead, please email security@alicebiometrics.com
+We'll reply to your email promptly and try to get a patch out ASAP.

.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: docs
+
+on:
+  push:
+    paths:
+      - 'docs/**'
+    branches:
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: pip
+    - name: Create Documentation
+      run: |
+        pip install lume
+        lume -docs
+    - name: Publish
+      run: mkdocs gh-deploy --force

.gitignore

@@ -80,3 +80,4 @@ target/
 *.idea
 .pytest_cache
 test-deps
+site