pipelight/CONTRIBUTING.md

Contributing

Build and Run

Download the source code.

git clone <repo_url>

And build on your machine.

cd <repo_name>
cargo build

Run tests with

cd <repo_name>
cargo tests

Try the built binary.

cargo run --bin pipelight

cargo run --bin pipelight --help

cargo run --bin pipelight ls

Internal documentation

The main documentaion can be found at pipelight.dev. It explains the tool usage and functionning, however it doesn't say much on internal structure.

1. The INTERNALS.md gives a quick overlook of how things works.

2. There is a README.md detailling what is inside most of modules(crate).

.
├── cast
│   ├── public
│   ├── README.md
│   └── src
├── cli
│   ├── build.rs
│   └── src
├── exec
│   ├── README.md
│   └── src
├── pipelight
│   ├── README.md
│   └── src
├── switch
│   └── src
├── templates
│   ├── README.md
│   ├── src
│   └── static
├── utils
│   ├── public
│   ├── README.md
│   └── src
└── workflow
    ├── README.md
    └── src

3. Each internal modules and functions have exhaustive and improving descriptions

Easy set up on Nixos

Deprecated usage of nix-shell command with shell.nix file in favor of nix develop with flake.nix.

To spawn a developing env with lsp formatter and linter.

nix develop

or do it automatically when you cd into the directory with nix-direnv