Skip to content

Commit

Permalink
Add formatting guidelines to CONTRIBUTING doc
Browse files Browse the repository at this point in the history
  • Loading branch information
olttwa committed Sep 23, 2024
1 parent b38b9da commit 0ea6c3a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ jobs:
RABBITMQ_DEFAULT_PASS: top-gun
steps:
- uses: actions/checkout@v3
- name: Check formatting
run: clj -M:cljfmt check
- name: Run tests
run: clj -X:test
env:
Expand All @@ -33,11 +31,13 @@ jobs:
GOOSE_TEST_RABBITMQ_PORT: 5672
GOOSE_TEST_RABBITMQ_USERNAME: goose
GOOSE_TEST_RABBITMQ_PASSWORD: top-gun
lint:
fmt_lint:
runs-on: ubuntu-20.04
container: cljkondo/clj-kondo:2022.10.05-alpine
steps:
- uses: actions/checkout@v3
- name: Check formatting
run: clj -M:cljfmt check
- name: Lint src
run: clj-kondo --lint src/
- name: Lint test
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ $ clj -X:test # Running all tests.
$ docker-compose down # ...when you're done.
```

Formatting
--------
- Goose adheres to the [weavejester/cljfmt](https://clojars.org/dev.weavejester/cljfmt) library to maintain consistent code formatting.
- Install the appropriate plugin for your IDE to ensure compliance.

```shell
$ clj -M:cljfmt fix # Automatically fix formatting issues.
$ clj -M:cljfmt check # Check any formatting inconsistencies.
```

Linting
--------
- Install [clj-kondo v2022.10.05](https://github.com/clj-kondo/clj-kondo/blob/master/doc/install.md#installation-script-macos-and-linux)
Expand Down

0 comments on commit 0ea6c3a

Please sign in to comment.