Skip to content

docs: Revise README.md for improved structure and clarity #36

docs: Revise README.md for improved structure and clarity

docs: Revise README.md for improved structure and clarity #36

Workflow file for this run

name: Format
on:
push:
branches: [main]
pull_request:
workflow_dispatch:
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
format:
name: Format
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout
uses: actions/checkout@v5
with:
fetch-depth: 0
persist-credentials: false
- name: Set up Go
uses: actions/setup-go@v6
with:
go-version-file: go.mod
cache: true
check-latest: false
- name: Install dprint
run: |
curl -fsSL https://dprint.dev/install.sh | sh
echo "$HOME/.dprint/bin" >> $GITHUB_PATH
- name: Check dprint formatting
run: make format
- name: Check for Formatting Changes
run: |
if [[ -n "$(git status --porcelain)" ]]; then
echo "❌ Some code is not formatted correctly. Please run 'make format' and commit the changes."
git status
git diff
exit 1
else
echo "✅ All code is formatted correctly."
fi