diff --git a/docs/development.md b/docs/development.md index ad3f5b5..72acb8f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -33,6 +33,14 @@ curl -sSfL https://raw.githubusercontent.com/osapi-io/osapi-justfiles/refs/heads Then run the consuming project's recipes to verify behavior. +## Before committing + +Run `just ready` before committing to ensure justfiles are properly formatted: + +```bash +just ready # fmt +``` + ## Branching All changes should be developed on feature branches. Create a branch from `main` diff --git a/justfile b/justfile new file mode 100644 index 0000000..4d6321d --- /dev/null +++ b/justfile @@ -0,0 +1,9 @@ +# Justfile formatting recipes run against local recipe files. + +# Check justfile formatting +test: + just --justfile just.just --working-directory . fmt-check + +# Format and lint before committing +ready: + just --justfile just.just --working-directory . fmt