Skip to content
This repository has been archived by the owner on Aug 10, 2024. It is now read-only.

Latest commit

 

History

History
25 lines (16 loc) · 714 Bytes

DEVELOPER.md

File metadata and controls

25 lines (16 loc) · 714 Bytes

Developer Notes

Recommended setup

Git hooks

We recommend using this for .git/hooks/pre-commit:

#!/bin/bash

./gradlew test

apiDump

Kweb's external API will be checked against api/kweb-core.api and the build will fail if it changes. This will often have false-positives so to update the API dump, run ./gradlew apiDump and commit the new dump file with your other changes.

Updating the user manual

You can build the user manual locally by installing mdBook and running mdbook serve in the docs/ directory. You can then view the documentation at http://localhost:3000/, changes will be automatically reloaded.