Refactored shell scripts. Fix - #91 #92
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benoit74
requested changes
Feb 26, 2024
CONTRIBUTING.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
I think docker run --rm -it -v "$PWD/output":/output local-kolibri2zim ... would be more correct, could you confirm it works as well?
There was a problem hiding this comment.
Yes, this also works fine. Will refactor this in the next commmit.
CHANGELOG.md
Outdated
| @@ -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) | |||
There was a problem hiding this comment.
This has to be added to the [Unreleased] section, not to the already released 1.2.0
I would rephrase this to "Enhance contribution guidelines", which is a bit too vague, but more inline with your intent.
CONTRIBUTING.md
Outdated
| @@ -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). | |||
There was a problem hiding this comment.
This should not be placed here, we should instead rewrite the contributions section:
- state the requirements more clearly: Python 3.12 and preferably Docker (which engine must run in the background)
- add mention of
pre-commitwhich must be activated (code must pass all pre-commit checks to succeed in the CI)
|
@benoit74 , Changes are done according to the request. |
benoit74
reviewed
Feb 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes made to
CONTRIBUTING.mdfor easy setup for new contributors.