> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# コントリビューションガイド

> YiDA 開発者センターのドキュメントへのコントリビューション方法を解説します。イシューによるフィードバックと Pull Request によるドキュメント編集の手順を紹介し、コミュニティを通じた YiDA ドキュメント改善への参加方法をご案内します。

本ガイドでは、**YiDA 開発者センター**へのコントリビューション方法をご紹介します。コントリビューションの方法にはイシューと Pull Request の 2 種類があります。

## イシュー

開発者センターのドキュメントに関する問題は、[GitHub Issues](https://github.com/dingtalk-yida/developer-site/issues) で管理しています。ドキュメントに問題を見つけた場合は、以下のテンプレートを使用してイシューを投稿してください。定期的に確認し、ドキュメントを更新します。

```
- ドキュメントリンク: https://yida-developer.gitee.io/docs/api/yidaAPI
- 説明: this.setState() の説明に誤りがあります。setState はコールバック関数をサポートしていません。
- 修正提案: setState API からコールバックの使用例を削除してください。
```

イシューを投稿する前に、重複を避けるため既存のイシューを検索してください。

## Pull Request

YiDA 開発者センターの改善には、Pull Request によるコントリビューションを推奨します。各ドキュメントの下部にある**このページを編集**ボタンをクリックすると、コントリビューションを開始できます。手順は以下のとおりです。

* **このページを編集**をクリックして GitHub のページに移動します（GitHub アカウントをお持ちでない場合は、新規登録してください）。

* 開発者センターのリポジトリを個人の GitHub スペースにフォークします（初回のみ必要な操作で、以降の編集ではスキップされます）。

* ドキュメント編集ページに移動し、変更を加えてコミットします。

* 変更内容を確認し、Pull Request を送信します。

以上で、シンプルな Pull Request の送信は完了です。YiDA チームはすべての Pull Request を確認しています。変更内容をレビューのうえマージするか、修正をお願いする場合があります。また、変更を受け入れられない場合はその理由をご説明します。master ブランチからは毎週パッチバージョンをリリースしています。

<Tip>
  開発者センターのリポジトリをローカル環境にフォークし、ローカルでドキュメントを編集して Pull Request を送信することもできます。GitHub で Pull Request を送信するのが初めての方は、以下の記事をご参照ください。

  [GitHub でスマートにコードをコントリビュートする方法](https://segmentfault.com/a/1190000000736629)

  メインブランチは master です。Pull Request は master に対して送信してください。
</Tip>

<Tip>
  新しいドキュメントコンテンツを送信する際は、Pull Request 内で背景やユースケースを簡潔にご説明ください。効率的なレビューと追加が可能になります。
</Tip>

## ローカル開発ワークフロー

YiDA 開発者センターは [Docusaurus 2](https://docusaurus.io/) で構築されています。開発者センターのリポジトリをクローンし、npm install で依存関係をインストールしたあと、以下のコマンドを実行できます。

### ローカル起動

```
$ npm start
```

起動後、`http://localhost:3000/` からローカルでアクセスできます。

> 補足：ローカル開発モードではグローバル検索は利用できません。

### ビルド

```
$ npm run build
```

ビルド結果は build ディレクトリに出力されます。

### 本番環境ビルドをローカルでプレビュー

```
$ npm run serve
```

このコマンドは `npm run build` の完了後にのみ実行してください。build ディレクトリを基にローカルの静的サーバーを起動し、`http://localhost:3000/` でアクセスできます。動作は本番環境と同一で、グローバル検索にも対応しています。