Skip to content

Commit

Permalink
docs: document use of 'just check'
Browse files Browse the repository at this point in the history
  • Loading branch information
dsloanm authored and NucciTheBoss committed Nov 12, 2024
1 parent 5626a93 commit e616bc9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit e616bc9

Please sign in to comment.