SECURITY.md (#208)

* doc : SECURITY.md added

* doc : CHANGELOG.md updated

* fix : version_check.py updated

* fix : SECURITY.md verison fixed

.github/dependabot.yml

@@ -7,3 +7,5 @@ updates:
     time: "01:30"
   open-pull-requests-limit: 10
   target-branch: dev
+  assignees:
+      - "sepandhaghighi"

.github/workflows/test.yml

@@ -59,9 +59,11 @@ jobs:
         python otherfiles/notebook_check.py
       if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
           fail_ci_if_error: true
+      env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
     - name: cProfile
       run: |

AUTHORS.md

@@ -1,10 +1,10 @@
-# Core Developer #
+# Core Developers
 
 ----------
-- Sepand Haghighi - Sharif University of Technology - [@sepandhaghighi](http://github.com/sepandhaghighi)
-- Sadra Sabouri - Sharif University of Technology - [@sadrasabouri](https://github.com/sadrasabouri)
+- Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
+- Sadra Sabouri - Open Science Laboratory ([Github](https://github.com/sadrasabouri))
 
-# Other Contributors #
+# Other Contributors
 - Mohammad Hosein Moslemi - [@mhmoslemi2338](https://github.com/mhmoslemi2338)
 - Evan Slack - [@evanofslack](https://github.com/evanofslack)
 ----------

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `config.yml` for issue template
 - `get_cmap` function
 - `Gateway` enum
+- `SECURITY.md`
 ### Changed
 - Bug report template modified
 - `func_seed` parameter added to GenerativeImage `__init__`

README.md

@@ -1,39 +1,28 @@
 <div align="center">
-<img src="https://github.com/sepandhaghighi/samila/raw/master/otherfiles/logo.png" width=400 height=400>
-<br/>
-<h1>Samila</h1>
-<br/>
-<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3" /></a>
-<a href="https://codecov.io/gh/sepandhaghighi/samila">
-  <img src="https://codecov.io/gh/sepandhaghighi/samila/branch/master/graph/badge.svg" />
-</a>
-<a href="https://badge.fury.io/py/samila"><img src="https://badge.fury.io/py/samila.svg" alt="PyPI version" height="18"></a>
-<a href="https://anaconda.org/sepandhaghighi/samila"><img src="https://anaconda.org/sepandhaghighi/samila/badges/version.svg"></a>
-<a href="https://colab.research.google.com/github/sepandhaghighi/samila/blob/master">
-  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Samila-Colab"/>
-</a>
-<a href="https://discord.com/invite/94bz5QGZWb">
-  <img src="https://img.shields.io/discord/900055829225562162.svg" alt="Discord Channel">
-</a>
+	<img src="https://github.com/sepandhaghighi/samila/raw/master/otherfiles/logo.png" width=400 height=400>
+	<br/>
+	<h1>Samila</h1>
+	<br/>
+	<a href="https://www.python.org/">
+		<img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3" />
+	</a>
+	<a href="https://codecov.io/gh/sepandhaghighi/samila">
+		<img src="https://codecov.io/gh/sepandhaghighi/samila/branch/master/graph/badge.svg" />
+	</a>
+	<a href="https://badge.fury.io/py/samila">
+		<img src="https://badge.fury.io/py/samila.svg" alt="PyPI version" height="18">
+	</a>
+	<a href="https://anaconda.org/sepandhaghighi/samila">
+		<img src="https://anaconda.org/sepandhaghighi/samila/badges/version.svg">
+	</a>
+	<a href="https://colab.research.google.com/github/sepandhaghighi/samila/blob/master">
+		<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Samila-Colab"/>
+	</a>
+	<a href="https://discord.com/invite/94bz5QGZWb">
+		<img src="https://img.shields.io/discord/900055829225562162.svg" alt="Discord Channel">
+	</a>
 </div>
 
-----------
-## Table of contents					
-   * [Overview](https://github.com/sepandhaghighi/samila#overview)
-   * [Installation](https://github.com/sepandhaghighi/samila#installation)
-   * [Usage](https://github.com/sepandhaghighi/samila#usage)
-   * [Mathematical Details](https://github.com/sepandhaghighi/samila#mathematical-details)
-   * [Try Samila in Your Browser](https://github.com/sepandhaghighi/samila#try-samila-in-your-browser)
-   * [Issues & Bug Reports](https://github.com/sepandhaghighi/samila#issues--bug-reports)
-   * [Social Media](https://github.com/sepandhaghighi/samila#social-media)
-   * [Contribution](https://github.com/sepandhaghighi/samila/blob/master/.github/CONTRIBUTING.md)
-   * [References](https://github.com/sepandhaghighi/samila#references)
-   * [Acknowledgments](https://github.com/sepandhaghighi/samila#acknowledgments)
-   * [Authors](https://github.com/sepandhaghighi/samila/blob/master/AUTHORS.md)
-   * [License](https://github.com/sepandhaghighi/samila/blob/master/LICENSE)
-   * [Show Your Support](https://github.com/sepandhaghighi/samila#show-your-support)
-   * [Changelog](https://github.com/sepandhaghighi/samila/blob/master/CHANGELOG.md)
-   * [Code of Conduct](https://github.com/sepandhaghighi/samila/blob/master/.github/CODE_OF_CONDUCT.md)
 
 ## Overview
 
@@ -213,7 +202,7 @@ You can even rotate your art by using `rotation` parameter. Enter your desired r
 
 ⚠️ In **List** mode, the length of this list must be equal to the lengths of data1 and data2
 
-#### Point Color
+#### Point color
 You can make your custom color map and use it in Samila
 
 ```pycon

SECURITY.md

@@ -0,0 +1,14 @@
+# Security policy
+
+## Supported versions
+
+| Version       | Supported          |
+| ------------- | ------------------ |
+| 1.1           | :white_check_mark: |
+| < 1.1         | :x:                |
+
+## Reporting a vulnerability
+
+Please report security vulnerabilities by email to [info@samila.site](mailto:info@samila.site "info@samila.site").
+
+If the security vulnerability is accepted, a dedicated bugfix release will be issued as soon as possible (depending on the complexity of the fix).

otherfiles/version_check.py

@@ -21,11 +21,13 @@ PARAMS_ITEMS = ['SAMILA_VERSION = "{0}"']
 
 META_ITEMS = ['% set version = "{0}" %']
 ISSUE_TEMPLATE_ITEMS = ["- Samila {0}"]
+SECURITY_ITEMS = ["| {0}           | :white_check_mark: |", "| < {0}         | :x:                |"]
 
 FILES = {
     "setup.py": SETUP_ITEMS,
     "README.md": README_ITEMS,
     "CHANGELOG.md": CHANGELOG_ITEMS,
+    "SECURITY.md": SECURITY_ITEMS,
     os.path.join("samila", "params.py"): PARAMS_ITEMS,
     os.path.join("otherfiles", "meta.yaml"): META_ITEMS,
     os.path.join(