From ab9d85029d8b3f8303ebd1a4ab57ac2deec6ca47 Mon Sep 17 00:00:00 2001
From: rayrayraykk <18007356109@163.com>
Date: Fri, 22 Jul 2022 12:00:35 +0800
Subject: [PATCH] Update contribute guidance

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 235124859..3495a9f98 100644
--- a/README.md
+++ b/README.md
@@ -261,7 +261,20 @@ More publications can be found in the [Publications](https://federatedscope.io/y
 
 ## Contributing
 
-We **greatly appreciate** any contribution to FederatedScope! You can refer to [Contributing to FederatedScope](https://federatedscope.io/docs/contributor/) for more details.
+We **greatly appreciate** any contribution to FederatedScope! We provide a developer version of FederatedScope with additional pre-commit hooks to perform commit checks compared to the official version:
+
+```bash
+# Install the developer version
+pip install -e .[dev]
+pre-commit install
+
+# Or switch to the developer version from the official version
+pip install pre-commit
+pre-commit install
+pre-commit run --all-files
+```
+
+You can refer to [Contributing to FederatedScope](https://federatedscope.io/docs/contributor/) for more details.
 
 Welcome to join in our [Slack channel](https://join.slack.com/t/federatedscopeteam/shared_invite/zt-1apmfjqmc-hvpYbsWJdm7D93wPNXbqww), or DingDing group (please scan the following QR code) for discussion.