Developer guide

Windows

Installing various programs

Visual Studio Code

Download & Install Visual Studio Code https://code.visualstudio.com/Download

2024-09-24.15-05-33.mp4

Git

Download & Install Git https://git-scm.com/download/win

2024-09-24.15-21-32.mp4

npm (node.js)

Download & Install node.js https://nodejs.org/en/download/prebuilt-installer

2024-09-24.15-27-07.mp4

Development

Preparations

1. Create a fork of WebToEpub in github.
2. Clone the fork to your pc
3. Set up upstream remote branch All commands:

git clone https://github.com/<your_name>/WebToEpub.git
cd WebToEpub
git remote add upstream https://github.com/dteviot/WebToEpub.git
git fetch upstream

2024-09-24.15-09-11.mp4

4. Set git credentials git push will prompt an login screen.
5. Set name and email

git config --global user.name "<your name>"
git config --global user.email "<your email>"

5. run npm install & npm run lint to check if everything works

Creating changes

Create new branch

To track the changes you make create a branch with a name that reflects these changes. Example: "Add xyParser" The new branch gets created from the remote upstream/ExperimentalTabMode branch.

git fetch upstream
git checkout -b <new_branch_name> upstream/ExperimentalTabMode

In the video the Visual Studio Code gui is used to create the new branch.

2024-09-24.18-07-27.mp4

Make your changes

Example: (Doesn't really create a new parser)

2024-09-24.18-10-02.mp4

Test your changes and fix errors

npm run lint can give errors that need to be fixed before they are accepted.

2024-09-24.18-10-53.mp4

Publish your changes/ branch

Only commit the changes you made not files that got automatically created from npm.

git add <your_changed_fiels>
git commit -m "<commit message>"

example:

git add plugin/js/parsers/xyParser.js
git add plugin/popup.html
git commit -m "Add xyParser"
git push

2024-09-24.18-12-04.mp4

Create Pull request

2024-09-24.18-14-01.mp4