update readme

OpenCSGs · Jan 20, 2025 · 51d4c53 · 51d4c53
1 parent 6dbbb3a
commit 51d4c53
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,8 @@ We use the Apache 2.0 license, the content of which is detailed in the `LICENSE`
 ## Contributing
 If you wish to contribute, please follow the [Contribution Guidelines](docs/en/contributing.md). We are very excited about your contributions!
 
+Before you begin development, we highly recommend checking out our [Backend Developer Guides](contribute/), which provide helpful information to ensure a smooth development process.
+
 ## Acknowledgments
 This project is based on open source projects such as Gin, DuckDB, minio, and Gitea. We would like to express our sincere gratitude to them for their open source contributions!
 

diff --git a/contribute/README.md b/contribute/README.md
@@ -0,0 +1,8 @@
+The contribution guidelines for CSGHub backend developers contain a lot of information for anyone who wants to contribute to our open source project.
+But you don't necessarily have to read all of it, so long as you read what is most relevant to you.
+
+## Guidelines specifically for backend developers
+
+For anyone who reviews code for the CSGHub backend, get a basic understanding of the content of the following files:
+
+- [Instrumentation](/contribute/instrumentation.md)