From bdd0bdbb34488c05ec5a5a67a15bba25a191b295 Mon Sep 17 00:00:00 2001 From: PaglaDasu Date: Fri, 23 Feb 2024 15:49:30 +0530 Subject: [PATCH 1/3] Refactored shell scripts --- CHANGELOG.md | 1 + CONTRIBUTING.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c303f79..421f23e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix caching of re-encoded video files (#82) - Do not start multiple video processing threads by default (`--processes` default value) (second part of #83) - Fix logging issue in DEBUG mode +- Refactored some shell scripts in `CONTRIBUTING.md` (#91) ## [1.1.1] - 2024-01-16 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a90ee5..eb481ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,7 @@ To simplify this, it is possible to: - iterate on ZIM UI code To achieve this, first build the Docker image based on current code base. +Make sure Docker is running in the background ("Docker Deamon" app for Windows and Mac, or `docker start` in Linux). ``` docker build -t local-kolibri2zim . @@ -44,7 +45,7 @@ docker build -t local-kolibri2zim . Scrape a channel (here we use the minimal channel, but you could use any other one of interest for your UI developments). ``` -docker run --rm -it -v $PWD/output:/output local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K +docker run --rm -it -v "$PWD/output:/output" local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K olibri Channel, with new Kolibri UI" --channel-id "7f744ce8d28b471eaf663abd60c92267" --zim-file "Minimal_Test.zim" ``` From ab1c91b851964085c133b642c0f1831c54596f33 Mon Sep 17 00:00:00 2001 From: PaglaDasu Date: Tue, 27 Feb 2024 20:18:36 +0530 Subject: [PATCH 2/3] Enhance contribution guidelines --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 421f23e..a53814c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +- Enhance contribution guidelines: Refactored shell scripts, added additional steps. ## [1.2.0] - 2024-02-16 @@ -22,7 +23,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix caching of re-encoded video files (#82) - Do not start multiple video processing threads by default (`--processes` default value) (second part of #83) - Fix logging issue in DEBUG mode -- Refactored some shell scripts in `CONTRIBUTING.md` (#91) ## [1.1.1] - 2024-01-16 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb481ae..17ffe80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,9 @@ * Open issues, bug reports and send PRs [on github](https://github.com/openzim/kolibri2zim). * Make sure it's `py3.6+` compatible. +* Docker (which engine must run in the background). * Use [black](https://github.com/psf/black) code formatting. +* `pre-commit` must be activated before (code must pass all pre-commit checks to succeed in the CI) ## notes @@ -36,7 +38,6 @@ To simplify this, it is possible to: - iterate on ZIM UI code To achieve this, first build the Docker image based on current code base. -Make sure Docker is running in the background ("Docker Deamon" app for Windows and Mac, or `docker start` in Linux). ``` docker build -t local-kolibri2zim . @@ -45,7 +46,7 @@ docker build -t local-kolibri2zim . Scrape a channel (here we use the minimal channel, but you could use any other one of interest for your UI developments). ``` -docker run --rm -it -v "$PWD/output:/output" local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K +docker run --rm -it -v "$PWD/output":/output local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K olibri Channel, with new Kolibri UI" --channel-id "7f744ce8d28b471eaf663abd60c92267" --zim-file "Minimal_Test.zim" ``` From ad8ff787b4aa01f67399ef5fec46ab50e0cd38de Mon Sep 17 00:00:00 2001 From: PaglaDasu Date: Wed, 28 Feb 2024 00:06:19 +0530 Subject: [PATCH 3/3] Enhance contribution guidelines --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a53814c..3f382b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] -- Enhance contribution guidelines: Refactored shell scripts, added additional steps. +- Enhance contribution guidelines: Refactored shell scripts, added additional steps. (#91) ## [1.2.0] - 2024-02-16