Skip to content
This repository was archived by the owner on Jul 14, 2025. It is now read-only.

Commit 588def3

Browse files
iFuryStiFurySt
committed
docs: Add contributing code workflow to local development documentation
1 parent 5fa3f20 commit 588def3

8 files changed

Lines changed: 335 additions & 7 deletions

File tree

‎docs/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,45 @@ export APISERVER_JWT_SECRET_KEY="your_secret_key"
115115
成功启动本地开发环境后，你可以：
116116

117117
- 查看 [架构文档](./architecture) 深入了解系统组件
118-
- 阅读 [配置指南](../configuration/gateways) 学习如何配置网关
118+
- 阅读 [配置指南](../configuration/gateways) 学习如何配置网关
119+
120+
## 贡献代码流程
121+
122+
在开始开发新功能或修复 bug 之前，请按照以下步骤设置你的开发环境：
123+
124+
1. 克隆你的 fork 仓库到本地：
125+
```bash
126+
git clone https://github.com/your-github-username/mcp-gateway.git
127+
```
128+
129+
2. 添加上游仓库：
130+
```bash
131+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
132+
```
133+
134+
3. 同步上游代码：
135+
```bash
136+
git pull upstream main
137+
```
138+
139+
4. 推送更新到你的 fork 仓库（可选）：
140+
```bash
141+
git push origin main
142+
```
143+
144+
5. 创建新的功能分支：
145+
```bash
146+
git switch -c feat/your-feature-name
147+
```
148+
149+
6. 开发完成后，推送你的分支到 fork 仓库：
150+
```bash
151+
git push origin feat/your-feature-name
152+
```
153+
154+
7. 在 GitHub 上创建 Pull Request，将你的分支合并到主仓库的 main 分支。
155+
156+
**提示**：
157+
- 分支命名建议使用 `feat/` 前缀表示新功能，`fix/` 前缀表示 bug 修复
158+
- 在提交 PR 之前，确保你的代码已经通过所有测试
159+
- 保持你的 fork 仓库与上游仓库同步，避免代码冲突

‎i18n/de/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="ihr_geheimer_schlüssel"
113113
Nach dem erfolgreichen Start der lokalen Entwicklungsumgebung können Sie:
114114

115115
- Die [Architekturdokumentation](./architecture) überprüfen, um die Systemkomponenten im Detail zu verstehen
116-
- Den [Konfigurationsleitfaden](../configuration/gateways) lesen, um zu erfahren, wie Sie das Gateway konfigurieren
116+
- Den [Konfigurationsleitfaden](../configuration/gateways) lesen, um zu erfahren, wie Sie das Gateway konfigurieren
117+
118+
## Workflow für Code-Beiträge
119+
120+
Bevor Sie mit der Entwicklung neuer Funktionen oder der Fehlerbehebung beginnen, folgen Sie bitte diesen Schritten, um Ihre Entwicklungsumgebung einzurichten:
121+
122+
1. Klonen Sie Ihr Fork-Repository lokal:
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. Fügen Sie das Upstream-Repository hinzu:
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. Synchronisieren Sie mit dem Upstream-Code:
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. Pushen Sie Updates zu Ihrem Fork-Repository (optional):
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. Erstellen Sie einen neuen Feature-Branch:
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. Nach der Entwicklung, pushen Sie Ihren Branch zum Fork-Repository:
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. Erstellen Sie einen Pull Request auf GitHub, um Ihren Branch in den main-Branch des Hauptrepositories zu mergen.
153+
154+
**Tipps**:
155+
- Branch-Namenskonvention: Verwenden Sie das Präfix `feat/` für neue Funktionen, `fix/` für Fehlerbehebungen
156+
- Stellen Sie sicher, dass Ihr Code alle Tests besteht, bevor Sie einen PR einreichen
157+
- Halten Sie Ihr Fork-Repository mit dem Upstream-Repository synchron, um Code-Konflikte zu vermeiden

‎i18n/en/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="your_secret_key"
113113
After successfully starting the local development environment, you can:
114114

115115
- Check the [Architecture Documentation](./architecture) to understand system components in depth
116-
- Read the [Configuration Guide](../configuration/gateways) to learn how to configure the gateway
116+
- Read the [Configuration Guide](../configuration/gateways) to learn how to configure the gateway
117+
118+
## Contributing Code Workflow
119+
120+
Before starting to develop new features or fix bugs, please follow these steps to set up your development environment:
121+
122+
1. Clone your fork repository locally:
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. Add upstream repository:
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. Sync with upstream code:
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. Push updates to your fork repository (optional):
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. Create a new feature branch:
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. After development, push your branch to the fork repository:
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. Create a Pull Request on GitHub to merge your branch into the main repository's main branch.
153+
154+
**Tips**:
155+
- Branch naming convention: use `feat/` prefix for new features, `fix/` prefix for bug fixes
156+
- Make sure your code passes all tests before submitting a PR
157+
- Keep your fork repository in sync with the upstream repository to avoid code conflicts

‎i18n/es/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="tu_clave_secreta"
113113
Después de iniciar exitosamente el entorno de desarrollo local, puedes:
114114

115115
- Revisar la [Documentación de Arquitectura](./architecture) para entender los componentes del sistema en profundidad
116-
- Leer la [Guía de Configuración](../configuration/gateways) para aprender cómo configurar la puerta de enlace
116+
- Leer la [Guía de Configuración](../configuration/gateways) para aprender cómo configurar la puerta de enlace
117+
118+
## Flujo de Trabajo para Contribuir Código
119+
120+
Antes de comenzar a desarrollar nuevas características o corregir errores, siga estos pasos para configurar su entorno de desarrollo:
121+
122+
1. Clone su repositorio fork localmente:
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. Agregue el repositorio upstream:
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. Sincronice con el código upstream:
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. Envíe las actualizaciones a su repositorio fork (opcional):
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. Cree una nueva rama de características:
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. Después del desarrollo, envíe su rama al repositorio fork:
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. Cree un Pull Request en GitHub para fusionar su rama en la rama main del repositorio principal.
153+
154+
**Consejos**:
155+
- Convención de nombres de ramas: use el prefijo `feat/` para nuevas características, `fix/` para correcciones de errores
156+
- Asegúrese de que su código pase todas las pruebas antes de enviar un PR
157+
- Mantenga su repositorio fork sincronizado con el repositorio upstream para evitar conflictos de código

‎i18n/fr/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="votre_clé_secrète"
113113
Après avoir réussi à démarrer l'environnement de développement local, vous pouvez :
114114

115115
- Consulter la [Documentation d'Architecture](./architecture) pour comprendre les composants du système en profondeur
116-
- Lire le [Guide de Configuration](../configuration/gateways) pour apprendre comment configurer la passerelle
116+
- Lire le [Guide de Configuration](../configuration/gateways) pour apprendre comment configurer la passerelle
117+
118+
## Flux de Travail pour Contribuer au Code
119+
120+
Avant de commencer à développer de nouvelles fonctionnalités ou à corriger des bugs, suivez ces étapes pour configurer votre environnement de développement :
121+
122+
1. Clonez votre dépôt fork localement :
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. Ajoutez le dépôt upstream :
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. Synchronisez avec le code upstream :
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. Poussez les mises à jour vers votre dépôt fork (optionnel) :
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. Créez une nouvelle branche de fonctionnalité :
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. Après le développement, poussez votre branche vers le dépôt fork :
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. Créez une Pull Request sur GitHub pour fusionner votre branche dans la branche main du dépôt principal.
153+
154+
**Conseils** :
155+
- Convention de nommage des branches : utilisez le préfixe `feat/` pour les nouvelles fonctionnalités, `fix/` pour les corrections de bugs
156+
- Assurez-vous que votre code passe tous les tests avant de soumettre une PR
157+
- Gardez votre dépôt fork synchronisé avec le dépôt upstream pour éviter les conflits de code

‎i18n/hi/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,47 @@ export OPENAI_MODEL="gpt-4o-mini"
108108
export APISERVER_JWT_SECRET_KEY="आपकी_गुप्त_कुंजी"
109109
```
110110

111+
## कोड योगदान वर्कफ़्लो
112+
113+
नई सुविधाओं को विकसित करने या बग्स को ठीक करने से पहले, अपने विकास वातावरण को सेट करने के लिए इन चरणों का पालन करें:
114+
115+
1. अपने फोर्क रिपॉजिटरी को स्थानीय रूप से क्लोन करें:
116+
```bash
117+
git clone https://github.com/your-github-username/mcp-gateway.git
118+
```
119+
120+
2. अपस्ट्रीम रिपॉजिटरी जोड़ें:
121+
```bash
122+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
123+
```
124+
125+
3. अपस्ट्रीम कोड के साथ सिंक्रनाइज़ करें:
126+
```bash
127+
git pull upstream main
128+
```
129+
130+
4. अपने फोर्क रिपॉजिटरी में अपडेट पुश करें (वैकल्पिक):
131+
```bash
132+
git push origin main
133+
```
134+
135+
5. नई फीचर ब्रांच बनाएं:
136+
```bash
137+
git switch -c feat/your-feature-name
138+
```
139+
140+
6. विकास के बाद, अपनी ब्रांच को फोर्क रिपॉजिटरी में पुश करें:
141+
```bash
142+
git push origin feat/your-feature-name
143+
```
144+
145+
7. GitHub पर एक Pull Request बनाएं ताकि आपकी ब्रांच मुख्य रिपॉजिटरी की main ब्रांच में मर्ज हो सके।
146+
147+
**सुझाव**:
148+
- ब्रांच नामकरण सम्मेलन: नई सुविधाओं के लिए `feat/` प्रीफिक्स, बग फिक्स के लिए `fix/` प्रीफिक्स का उपयोग करें
149+
- PR जमा करने से पहले सुनिश्चित करें कि आपका कोड सभी परीक्षणों को पास करता है
150+
- कोड कॉन्फ्लिक्ट्स से बचने के लिए अपने फोर्क रिपॉजिटरी को अपस्ट्रीम रिपॉजिटरी के साथ सिंक्रनाइज़ रखें
151+
111152
## अगले कदम
112153

113154
स्थानीय विकास पर्यावरण को सफलतापूर्वक प्रारंभ करने के बाद, आप:

‎i18n/ja/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="あなたのシークレットキー"
113113
ローカル開発環境を正常に起動した後、以下のことができます：
114114

115115
- [アーキテクチャドキュメント](./architecture)を確認して、システムコンポーネントを詳しく理解する
116-
- [設定ガイド](../configuration/gateways)を読んで、ゲートウェイの設定方法を学ぶ
116+
- [設定ガイド](../configuration/gateways)を読んで、ゲートウェイの設定方法を学ぶ
117+
118+
## コード貢献のワークフロー
119+
120+
新機能の開発やバグ修正を始める前に、以下の手順で開発環境をセットアップしてください：
121+
122+
1. フォークしたリポジトリをローカルにクローン：
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. アップストリームリポジトリの追加：
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. アップストリームコードとの同期：
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. フォークリポジトリへの更新のプッシュ（オプション）：
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. 新機能ブランチの作成：
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. 開発完了後、ブランチをフォークリポジトリにプッシュ：
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. GitHubでプルリクエストを作成し、ブランチをメインリポジトリのmainブランチにマージします。
153+
154+
**ヒント**：
155+
- ブランチ命名規則：新機能には`feat/`プレフィックス、バグ修正には`fix/`プレフィックスを使用
156+
- PRを提出する前に、コードがすべてのテストをパスすることを確認してください
157+
- コードの競合を避けるため、フォークリポジトリをアップストリームリポジトリと同期させておくことをお勧めします

‎i18n/ko/docusaurus-plugin-content-docs/current/development/local-development.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,45 @@ export APISERVER_JWT_SECRET_KEY="당신의_비밀_키"
113113
로컬 개발 환경을 성공적으로 시작한 후, 다음을 수행할 수 있습니다:
114114

115115
- [아키텍처 문서](./architecture)를 확인하여 시스템 구성 요소를 깊이 이해하기
116-
- [구성 가이드](../configuration/gateways)를 읽고 게이트웨이 구성 방법 학습하기
116+
- [구성 가이드](../configuration/gateways)를 읽고 게이트웨이 구성 방법 학습하기
117+
118+
## 코드 기여 워크플로우
119+
120+
새로운 기능 개발이나 버그 수정을 시작하기 전에 다음 단계에 따라 개발 환경을 설정하세요:
121+
122+
1. 포크한 저장소를 로컬에 클론:
123+
```bash
124+
git clone https://github.com/your-github-username/mcp-gateway.git
125+
```
126+
127+
2. 업스트림 저장소 추가:
128+
```bash
129+
git remote add upstream git@github.com:mcp-ecosystem/mcp-gateway.git
130+
```
131+
132+
3. 업스트림 코드와 동기화:
133+
```bash
134+
git pull upstream main
135+
```
136+
137+
4. 포크 저장소에 업데이트 푸시 (선택사항):
138+
```bash
139+
git push origin main
140+
```
141+
142+
5. 새로운 기능 브랜치 생성:
143+
```bash
144+
git switch -c feat/your-feature-name
145+
```
146+
147+
6. 개발 완료 후, 브랜치를 포크 저장소에 푸시:
148+
```bash
149+
git push origin feat/your-feature-name
150+
```
151+
152+
7. GitHub에서 Pull Request를 생성하여 브랜치를 메인 저장소의 main 브랜치에 병합합니다.
153+
154+
**팁**:
155+
- 브랜치 명명 규칙: 새 기능은 `feat/` 접두사, 버그 수정은 `fix/` 접두사 사용
156+
- PR을 제출하기 전에 코드가 모든 테스트를 통과하는지 확인하세요
157+
- 코드 충돌을 피하기 위해 포크 저장소를 업스트림 저장소와 동기화 상태로 유지하세요

0 commit comments

Comments
 (0)