Thank you so much for showing an interest in contributing to resin! I am excited to see what you have to add :)
resin uses the nightly distribution of the rust toolchain. You can get on the nightly edition of rustfmt, the only toolchain component used by resin, by running the following command:
rustup component add rustfmt --toolchain nightlyresin uses cargo-make for all build scripts. Please run the following command to install cargo-make:
cargo install --force cargo-makeOnce you have cargo-make installed you can run cargo make TASK_NAME to run a certain task. All tasks are prefixed with tasks. and are stored in the Makefile.toml file. So if you wanted to build the development binary for example you would run the following command:
cargo make build-rust-devresin only uses two linters: hadolint and rustfmt. hadolint will lint the dockerfiles stored in docker/ and rustfmt will lint the source code in src/. Please install hadolint using your system's package manager and rustfmt with the toolchain command provided in the 🦀 Rust Toolchain section.
resin uses a GitHub action called gh_fsync to automatically sync certain files from other repositories. The configuration for gh_fsync is stored in fsync.yml. This all means that if you update a file in this repository before removing it from the configuration then gh_fsync will reset it back. If you are looking to change a file for resin that is listed in the configuration please remove it from the configuration or update the source file.
That's all, good luck with your contribution, and please make an issue if anything doesn't make sense.