From 51d4c5350544682fdf36087264ca4995aa97d49b Mon Sep 17 00:00:00 2001 From: yiling Date: Mon, 20 Jan 2025 11:30:07 +0800 Subject: [PATCH] update readme --- README.md | 2 ++ contribute/README.md | 8 ++++++++ 2 files changed, 10 insertions(+) create mode 100644 contribute/README.md diff --git a/README.md b/README.md index d4f04b11..8b48359f 100644 --- 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 new file mode 100644 index 00000000..0bb8fedc --- /dev/null +++ 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)