6. Contributing

Building from source

• Install Rust. If it already installed, update with

$ rustup update

• Fork this project using button Fork on the top of this page
• Clone your fork (replace <YOUR_USERNAME> with your username on GitHub):

$ git clone https://github.com/<YOUR_USERNAME>/envfetch.git

• Go to directory, where you cloned envfetch:

$ cd envfetch

• Run program using Cargo (replace <COMMAND> and <ARGS> to your command and args):

$ cargo run -- <COMMAND> <ARGS>

• Or, install it globally on your PC using:

$ cargo install --path .

Contributing

• Read section above to build envfetch from source
• Create new branch
• Made your changes
• Test that everything works correctly
• Format and lint code with

$ cargo fmt
$ cargo clippy --fix

• Run tests with

$ cargo test

• Push changes
• Open pull request

Project structure

Find some information about project structure here.