45 lines (28 loc) · 1.1 KB

Contributing

Thanks for contributing to CodeVerse Linux (CVH Linux).

Setup (build environment)

This project builds an ArchISO and is easiest to work on from an Arch-based host.

Required tools for ISO builds:

archiso (provides mkarchiso)
squashfs-tools (provides mksquashfs)
libisoburn (provides xorriso)
grub (provides grub-mkrescue)

Install (Arch):

sudo pacman -S archiso squashfs-tools libisoburn grub

If you touch src/ (Rust tools), install Rust via rustup.

Common tasks

Build packages: ./scripts/build-packages.sh
Build ISO: ./scripts/build-iso.sh

More detail: docs/BUILD.md.

Testing changes

Recommended: test in a VM first.

Boot the ISO in QEMU/virt-manager
Smoke test:
- Boot to live environment
- Run cvh-install and complete an install on a disposable virtual disk

VM walkthrough: docs/TESTING.md.

Submitting a PR

Fork the repo and create a feature branch.
Keep PRs focused (one logical change).
Describe what changed and how it was tested.
Submit a pull request using the PR template.