From 2e85b4f9917d3c2f5954ee0f86a03505bec66243 Mon Sep 17 00:00:00 2001 From: Sepand Haghighi Date: Mon, 6 Jan 2025 20:14:20 +0330 Subject: [PATCH] Minor edits (#38) * doc : CONTRIBUTING.md updated * doc : SECURITY.md updated * doc : codecov badge bug fixed * doc : CHANGELOG.md updated --- .github/CONTRIBUTING.md | 2 +- CHANGELOG.md | 3 +++ README.md | 2 +- SECURITY.md | 1 + otherfiles/version_check.py | 2 +- 5 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 76ad605..6330138 100644 --- a/.github/CONTRIBUTING.md +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fedeec..f1cd3b6 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/README.md b/README.md index 414d59a..ccd17d4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

OPR: Optimized Primer


- Codecov + Codecov PyPI version built with Python3 Discord Channel diff --git a/SECURITY.md b/SECURITY.md index 4bf3525..aa8eb4e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,6 +5,7 @@ | Version | Supported | | ------------- | ------------------ | | 0.1 | :white_check_mark: | +| < 0.1 | :x: | ## Reporting a vulnerability diff --git a/otherfiles/version_check.py b/otherfiles/version_check.py index 1d27cf5..efcd458 100644 --- a/otherfiles/version_check.py +++ b/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,