Developing
This document describes how to get started with Vimm DL development.
Conventions
The Vimm DL project adheres to the following conventions and specifications:
Semantic Versioning
All releases are versioned following Semantic Versioning v2.0.0.
Git Commit Messages
The structure of Git commit messages follows Conventional Commits v1.0.0.
Development
Prerequisites
Ensure that you have the following tools installed:
Workflow
The current development workflow uses a 3-step loop:
1. Make changes
Make your edits to the source code.
All of the source code is located in src folder. The only exception is
main.ts which is located in the root directory of the project.
2. Compile
Once you have made your changes, compile the the binary for a specific platform.
For example, for a Linux system on the amd64 architecture:
deno task compile:x86_64-linux
The compiled binary will be stored in target/x86_64-unknown-linux-gnu.
Check the Compiling from Source page for more details, such as how to compile for other platforms.
3. Test
Test your changes by running the binary:
target/x86_64-unknown-linux-gnu/vimm-dl https://vimm.net/vault/5953 --destination ~/Downloads
Use a variety of options to ensure that the new changes work across different situations. If your tests fail, then go back to step 1.
4. Submit a patch
Once you happy with your changes, submit a patch in order to have your changes incorporated into the main Vimm DL project.
Copyright © 2024 Foster Hangdaan
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page entitled GNU Free Documentation License.