Add pre-commit hooks configuration

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint-sol
+        name: "lint core sol"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:sol"
+        files: '\.sol$'
+        language: script
+        description: "Checks solidity code according to the package's linter configuration"
+      - id: lint-js
+        name: "lint core ts/js"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:js"
+        files: '\.(ts|js)$'
+        language: script
+        description: "Checks TS/JS code according to the package's linter configuration"
+      - id: lint-config
+        name: "lint core json/yaml"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:config"
+        files: '\.(json|yaml)$'
+        language: script
+        description: "Checks JSON/YAML code according to the package's linter configuration"

README.md

@@ -1,2 +1,21 @@
 # litmus
 Bitcoin Liquid Staking
+
+# Development
+
+## Pre-commit Hooks
+
+Developers are encouraged to use [pre-commit](https://pre-commit.com/) hooks to
+automatically discover code issues, before they submit the code.
+
+To setup the hooks follow the steps:
+
+1. Install `pre-commit` tool:
+    ```sh
+    brew install pre-commit
+    ```
+
+2. Install the hooks for the repository:
+    ```sh
+    pre-commit install
+    ```