Minor edits (#38)

* doc : CONTRIBUTING.md updated

* doc : SECURITY.md updated

* doc : codecov badge bug fixed

* doc : CHANGELOG.md updated

.github/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Please consider the following :
 2. Create your feature branch (under `dev` branch)
 3. Add your functions/methods to proper files
 4. Add standard `docstring` to your functions/methods
-5. Add tests for your functions/methods (`doctest` testcases in `test` folder)
+5. Add tests for your functions/methods (`unittest` testcases in `tests` folder)
 6. Pass all CI tests
 7. Update `CHANGELOG.md`
 	- Describe changes under `[Unreleased]` section

CHANGELOG.md

@@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `single_runs` property
 ### Changed
 - Test system modified
+- `SECURITY.md` updated
+- `CONTRIBUTING.md` updated
+- `README.md` updated
 ### Removed
 - `property` deleter & setter
 ## [0.1] - 2024-11-27

README.md

@@ -2,7 +2,7 @@
     <img src="https://github.com/openscilab/opr/raw/main/otherfiles/logo.png" width="250">
     <h1>OPR: Optimized Primer</h1>
     <br/>
-    <a href="https://codecov.io/gh/openscilab/opr"><img src="https://codecov.io/gh/openscilab/opr/branch/main/graph/badge.svg" alt="Codecov"></a>
+    <a href="https://codecov.io/gh/openscilab/opr"><img src="https://codecov.io/gh/openscilab/opr/branch/dev/graph/badge.svg" alt="Codecov"></a>
     <a href="https://badge.fury.io/py/opr"><img src="https://badge.fury.io/py/opr.svg" alt="PyPI version"></a>
     <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://discord.gg/8mBspwXqcA"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>

SECURITY.md

@@ -5,6 +5,7 @@
 | Version       | Supported          |
 | ------------- | ------------------ |
 | 0.1           | :white_check_mark: |
+| < 0.1         | :x:                |
 
 ## Reporting a vulnerability
 

otherfiles/version_check.py

@@ -20,7 +20,7 @@
 PARAMS_ITEMS = ['OPR_VERSION = "{0}"']
 META_ITEMS = ['% set version = "{0}" %']
 ISSUE_TEMPLATE_ITEMS = ["- OPR {0}"]
-SECURITY_ITEMS = ["| {0}           | :white_check_mark: |"]
+SECURITY_ITEMS = ["| {0}           | :white_check_mark: |", "| < {0}         | :x:                |"]
 
 FILES = {
     os.path.join("otherfiles", "meta.yaml"): META_ITEMS,