From 2fd2871188330e83370582c59951f99c6cfc8420 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:19:14 +0430 Subject: [PATCH 01/10] doc : SECURITY.md added --- SECURITY.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..01313d5 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security policy + +## Supported versions + +| Version | Supported | +| ------------- | ------------------ | +| 0.5 | :white_check_mark: | +| < 0.6 | :x: | + +## Reporting a vulnerability + +Please report security vulnerabilities by email to [nava@openscilab.com](mailto:nava@openscilab.com "nava@openscilab.com"). + +If the security vulnerability is accepted, a dedicated bugfix release will be issued as soon as possible (depending on the complexity of the fix). \ No newline at end of file From 85512a7d2e5c32a6bab860452fb76f06825e9275 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:21:14 +0430 Subject: [PATCH 02/10] fix : version_check.py updated --- others/version_check.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/others/version_check.py b/others/version_check.py index 44e9eb1..45d45d1 100644 --- a/others/version_check.py +++ b/others/version_check.py @@ -20,12 +20,14 @@ PARAMS_ITEMS = ['NAVA_VERSION = "{0}"'] META_ITEMS = ['% set version = "{0}" %'] ISSUE_TEMPLATE_ITEMS = ["- Nava {0}"] +SECURITY_ITEMS = ["| {0} | :white_check_mark: |", "| < {0} | :x: |"] FILES = { os.path.join("others", "meta.yaml"): META_ITEMS, "setup.py": SETUP_ITEMS, "README.md": README_ITEMS, "CHANGELOG.md": CHANGELOG_ITEMS, + "SECURITY.md": SECURITY_ITEMS, os.path.join("nava", "params.py"): PARAMS_ITEMS, os.path.join(".github", "ISSUE_TEMPLATE", "bug_report.yml"): ISSUE_TEMPLATE_ITEMS, } From 56422756b762dd24bcea91e072fa072d6d773985 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:23:36 +0430 Subject: [PATCH 03/10] doc : RELEASE.md updated --- others/RELEASE.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/others/RELEASE.md b/others/RELEASE.md index fe8efee..a3034b5 100644 --- a/others/RELEASE.md +++ b/others/RELEASE.md @@ -1,15 +1,16 @@ # Nava Release Instructions -#### Last Update: 2024-02-12 +#### Last Update: 2024-04-20 1. Create the `release` branch under `dev` 2. Update all version tags 1. `setup.py` 2. `README.md` - 3. `others/version_check.py` - 4. `others/meta.yaml` - 5. `nava/params.py` + 3. `SECURITY.md` + 4. `others/version_check.py` + 5. `others/meta.yaml` + 6. `nava/params.py` 3. Update `CHANGELOG.md` 4. Update `.github/ISSUE_TEMPLATE/bug_report.yml` 1. Add new version tag to `Nava version` dropbox options From 80966db25ccb973cd57bed20fe23a75a5a978a2e Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:24:09 +0430 Subject: [PATCH 04/10] doc : SECURITY.md version fixed --- SECURITY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SECURITY.md b/SECURITY.md index 01313d5..b7b324a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,7 +5,7 @@ | Version | Supported | | ------------- | ------------------ | | 0.5 | :white_check_mark: | -| < 0.6 | :x: | +| < 0.5 | :x: | ## Reporting a vulnerability From 806fcc225868bf2945e0f6d6656e76703869704c Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:26:37 +0430 Subject: [PATCH 05/10] doc : badges text-decoration bug fixed --- README.md | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f172cdc..05e1b97 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,11 @@

Nava


- - built with Python3 - - - PyPI version - - - - - - Codecov - - - Discord Channel - + built with Python3 + PyPI version + + Codecov + Discord Channel ## Overview From e5e2f73f9c8743685db55576db6fe6b22dbaf24b Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:28:01 +0430 Subject: [PATCH 06/10] doc : indent in README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 05e1b97..9ecb764 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,8 @@ stop(sound_id) ### Loop mode -⚠️ The `loop` parameter has a default value of `False` +⚠️ The `loop` parameter has a default value of `False` + ⚠️ You should always set `async_mode` flag when you are using `loop` ```python From e5f7522619697498080024acfeb602bc27404b10 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:28:47 +0430 Subject: [PATCH 07/10] doc : CHANGELOG.md updated --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4035feb..94d150e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Added +- `SECURITY.md` ### Changed - OSs local checklist added to pull request template +- `README.md` modified ## [0.5] - 2024-04-03 ### Changed - `loop` parameter added to `play` function From 655053580e05a4f54fbe0fb6ba32cb8874ced676 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:29:26 +0430 Subject: [PATCH 08/10] doc : minor edit in PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e7f24cc..f6716b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,9 +4,9 @@ #### Any other comments? -## Local tests on OSs +### Local tests on OSs -- [ ] MacOS +- [ ] macOS - [ ] Sonoma - [ ] Windows - [ ] Windows 11 From 40302c1ced5533293c1b98ec80b479bbf4505e3b Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 11:39:23 +0430 Subject: [PATCH 09/10] doc : email address changed --- .github/CODE_OF_CONDUCT.md | 2 +- README.md | 2 +- setup.py | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 7d590c9..270c4d2 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -58,7 +58,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -info@openscilab.com. +nava@openscilab.com. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/README.md b/README.md index 9ecb764..0ce222d 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ List of different platforms and the corresponding engines that are used for soun ## Issues & bug reports -Just fill an issue and describe it. We'll check it ASAP! or send an email to [info@openscilab.com](mailto:info@openscilab.com "info@openscilab.com"). +Just fill an issue and describe it. We'll check it ASAP! or send an email to [nava@openscilab.com](mailto:nava@openscilab.com "nava@openscilab.com"). - Please complete the issue template diff --git a/setup.py b/setup.py index b26d4f6..2c1aebe 100644 --- a/setup.py +++ b/setup.py @@ -36,8 +36,8 @@ def read_description(): description='A Python library for playing sound everywhere natively and securely.', long_description=read_description(), long_description_content_type='text/markdown', - author='OpenSciLab Development Team', - author_email='info@openscilab.com', + author='Nava Development Team', + author_email='nava@openscilab.com', url='https://github.com/openscilab/nava', download_url='https://github.com/openscilab/nava/tarball/v0.5', keywords="sound wav music mp3 player audio", From eaa1f912cc95c7168816e6b6975b413eb9b0aaf5 Mon Sep 17 00:00:00 2001 From: sepandhaghighi Date: Sat, 20 Apr 2024 12:26:17 +0430 Subject: [PATCH 10/10] doc : minor edit in PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f6716b2..7366f59 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ #### Any other comments? -### Local tests on OSs +#### Local tests on OSs - [ ] macOS - [ ] Sonoma