diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 134f3f0..d401f92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,11 +158,8 @@ Adhering to the following process is the best way to get your contribution accep 4. Ensure that your changes pass validation: ```bash - # Apply formatting standards to files. - tofu fmt - - # Ensure files are syntactically valid. - tofu validate + # Apply formatting standards and ensure files are syntactically valid. + just check ``` 5. Commit your changes in logical chunks to your topic branch. diff --git a/README.md b/README.md index c31924e..1280a38 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,17 @@ To learn more about the deployment and use of a Charmed HPC cluster, the followi ## 🛠️ Development -Useful [OpenTofu](https://opentofu.org/) commands to help while hacking on the plans: +A useful command to help while hacking on the plans is: ```shell -tofu fmt # Apply formatting standards to files. -tofu validate # Ensure files are syntactically valid. +just check # Checks file formatting and syntax are valid. +``` + +or equivalent [OpenTofu](https://opentofu.org/) commands: + +```shell +tofu fmt -check -recursive # Apply formatting standards to files. +tofu validate # Ensure files are syntactically valid. ``` If you're interested in contributing, take a look at our [contributing guidelines](./CONTRIBUTING.md).