hyperlight-dev / hyperlight-dev/hyperlight

Consider renaming files named `mod.rs/x86_64.rs/aarch64.rs` to more unique filenames

Open
#1,762 1 comment 0 reactions 0 assignees View on GitHub
lifecycle/needs-review
Dominant language
Rust
Stars
4.7k
Forks
208
Avg merge
1d 7h
Merged PRs (30d)
47

Description

Having multiple files with same name makes it annoying to search and find specific files.

For the `x86_64.rs/aarch64.rs` files (example `src/hyperlight_host/src/hypervisor/hyperlight_vm/x86_64.rs`) we could put them in a folder with that name instead (as we already do in certain places for example `src/hyperlight_host/src/hypervisor/regs/x86_64/special_regs.rs`).

For mod.rs file we can consider moving to the newer rust module convention which uses less mod.rs files.

I'm not saying all existing files must be renamed and are all bad, but I personally would like a bit more uniqueness

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the `mod.rs`, `x86_64.rs`, and `aarch64.rs` files, including `src/hyperlight_host/src/hypervisor/hyperlight_vm/x86_64.rs`, and compare them with `src/hyperlight_host/src/hypervisor/regs/x86_64/special_regs.rs`. Determine which files can use the newer Rust module convention and which architecture files should move into uniquely named directories. Done means the agreed renames are applied consistently without breaking the project checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
developer-experience, operating-systems
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.