docs: describe development environment setup

RobotecAI · Sep 5, 2024 · 6c1a194 · 6c1a194
1 parent 6b5071e
commit 6c1a194
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,7 +31,7 @@ Some of the easiest ways to contribute to RAI involve engaging in community disc
 
 ### Setting up the development environment
 
-To get started install RAI from source code using these [instructions](/README.md).
+To get started install RAI from source code using these [instructions](docs/developer_guide.md#developer-environment-setup).
 
 ### Starting the discussion
 

diff --git a/docs/developer_guide.md b/docs/developer_guide.md
@@ -3,6 +3,16 @@
 RAI is a flexible AI agent framework designed to handle tasks in generalized manner.
 It is easily extendable, allowing developers to adapt and integrate new functionalities and tools to meet their needs.
 
+## Development Environment Setup
+
+1. Follow installation instructions from [Quick Start](../README.md#quick-start)
+2. Activate [pre-commit](https://pre-commit.com) hook for automatic code checking
+   and formatting (it uses [../.pre-commit-config.yaml](../.pre-commit-config.yaml)).
+
+   ```bash
+   pre-commit install
+   ```
+
 ## Try out RAI
 
 ```python