# Contributing

## Local development

Run `git clone https://github.com/alexxyu/ferro.git` to clone this repository onto your
local machine.

You can run `cargo build` to build the executable and `cargo test` to run the unit tests.
When developing, you can use `cargo run [file]` to run the program to edit the given file
(if specified). Otherwise, `cargo run` will edit a new file.

## Issues and PRs

Feel free to open a new issue if you find a bug or have a feature suggestion. Please be
as specific as possible in the body of the issue.

PRs should similarly be detailed with the changes made. Make sure to complete the checklist
before marking the PR for review.