SECURITY.md (#35)

* doc : SECURITY.md added

* fix : version_check.py updated

* doc : RELEASE.md updated

* doc : minor edit in AUTHORS.md titles

* doc : minor edit in README.md titles

* doc : CHANGELOG.md updated

AUTHORS.md

@@ -1,11 +1,11 @@
-# Authors #
+# Core Developers
 
 ----------
 - AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
 - Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
 
 ** **Maintainer**
 
-# Other Contributors #
+# Other Contributors
 ----------
 - Amir Boreshnavard ([Telegram](https://t.me/ABoreshnavard))

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `dmeta/errors.py`
 - `pptx` and `xlsx` support
 - `get_microsoft_format` function in `util.py`
+- `SECURITY.md`
 ### Changed
 - `run_dmeta` in `functions.py`
 - `read_json` in `util.py`

README.md

@@ -139,7 +139,7 @@ You can also join our discord server
 </a>
 
 
-## Show Your Support
+## Show your support
 
 
 ### Star this repo

SECURITY.md

@@ -0,0 +1,14 @@
+# Security policy
+
+## Supported versions
+
+| Version       | Supported          |
+| ------------- | ------------------ |
+| 0.1           | :white_check_mark: |
+| < 0.1         | :x:                |
+
+## Reporting a vulnerability
+
+Please report security vulnerabilities by email to [[email protected]](mailto:[email protected] "[email protected]").
+
+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/RELEASE.md

@@ -1,14 +1,15 @@
 # DMeta Release Instructions
 
-#### Last Update: 2023-12-20
+**Last Update: 2024-08-04**
 
 1. Create the `release` branch under `dev`
 2. Update all version tags
 	1. `setup.py`
 	2. `README.md`
-	3. `otherfiles/version_check.py`
-	4. `otherfiles/meta.yaml`
-	5. `dmeta/params.py`
+	3. `SECURITY.md`
+	4. `otherfiles/version_check.py`
+	5. `otherfiles/meta.yaml`
+	6. `dmeta/params.py`
 3. Update `CHANGELOG.md`
 	1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`)
 	2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/openscilab/dmeta/compare/v0.1...v0.2`)

otherfiles/version_check.py

@@ -19,12 +19,14 @@
     "[{0}]:"]
 PARAMS_ITEMS = ['DMETA_VERSION = "{0}"']
 META_ITEMS = ['% set version = "{0}" %']
+SECURITY_ITEMS = ["| {0}           | :white_check_mark: |", "| < {0}         | :x:                |"]
 
 FILES = {
     os.path.join("otherfiles", "meta.yaml"): META_ITEMS,
     "setup.py": SETUP_ITEMS,
     "README.md": README_ITEMS,
     "CHANGELOG.md": CHANGELOG_ITEMS,
+    "SECURITY.md": SECURITY_ITEMS,
     os.path.join("dmeta", "params.py"): PARAMS_ITEMS,
 }