From 054b4bf27cc4311d6c4fc3862fb037c18829ee90 Mon Sep 17 00:00:00 2001
From: lowjiansheng <15527690+lowjiansheng@users.noreply.github.com>
Date: Tue, 23 Sep 2025 02:18:38 +0800
Subject: [PATCH] add github rules

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 77b85e519..a7bf6a681 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
+# Github Forked Branch Rules
+`master` - kept in sync with main repository. Do not merge anything into this branch other than sync code.
+`develop` - default branch of this forked repository. Merge all PRs into this branch.
+`release` - only release from this branch. Merge the `develop` into `release` branch before doing a tagged release.
+
 # Go OpenAI
 [![Go Reference](https://pkg.go.dev/badge/github.com/sashabaranov/go-openai.svg)](https://pkg.go.dev/github.com/sashabaranov/go-openai)
 [![Go Report Card](https://goreportcard.com/badge/github.com/sashabaranov/go-openai)](https://goreportcard.com/report/github.com/sashabaranov/go-openai)