貢献ガイド

このガイドでは、宜搭開発者センターに貢献する方法を説明します。IssuesとPull Requestの2つの共同作業方式を提供しています。

Issues

私たちはGitHub Issuesを使用して開発者センターの問題追跡を行っています。ドキュメントに問題を発見した場合は、以下のテンプレートを使用してissueを提出してください。私たちは定期的にレビューし、ドキュメントを修正します。

- 問題のあるドキュメントリンク：https://yida-developer.gitee.io/docs/api/yidaAPI；
- 問題の説明：this.setState()の記述に誤りがある。setStateはコールバック関数をサポートしない；
- 推奨修正案：setState APIからcallbackの使用法を削除する；

issueを報告する前に、既存のissueを検索したことを確認してください。

Pull Request

私たちは、Pull Requestの方式で宜搭開発者センターの共同作業にご協力いただけることをより推奨しています。ユーザーは各ドキュメントの最下部にあるこのページを編集ボタンをクリックして、ドキュメントの共同作成に迅速に参加できます。具体的な手順は以下の通りです。

• このページを編集をクリックしてgithubページに移動（githubアカウントがない場合は登録が必要）；

• 開発者センターのリポジトリを個人のgithubスペースにfork（一度だけ操作すればよく、今後の修正申請ではこの手順をスキップできます）；

• ドキュメント修正ページに移動し、ドキュメントを修正して提出：

• 修正内容を確認し、Pull Requestを提出：

以上で、簡易なPull Requestの提出が完了しました。宜搭チームはすべてのPull Requestを注視しており、レビューおよびあなたの修正のマージを行います。また、いくつかの修正を求める場合や、そのような修正を受け入れられない理由を説明する場合があります。毎週masterからpatchバージョンをリリースしています。

ヒント

開発者は、開発者センターのリポジトリを直接ローカルにforkしてドキュメント編集し、Pull Requestを提出することもできます。GitHub上でPull Requestを出す方法がわからない場合は、以下の記事を読んで学習できます。

GitHubでコードを貢献する方法

私たちはmasterブランチをメインの開発ブランチとして管理しているため、masterへのPull Requestを提出してください。

ヒント

開発者が新規ドキュメントコンテンツを提出する必要がある場合は、Pull Request内で背景と使用シナリオを簡単に記述し、私たちが確認および追加できるようにしてください。

ローカル開発手順

宜搭開発者センターはDocusaurus 2で構築された開発者プラットフォームです。開発者センターのコードをcloneし、npm installで依存関係をインストールした後、以下の一般的なコマンドを実行できます。

ローカル起動

$ npm start

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

P.S.: ローカル起動の際は、グローバル検索は有効になりません。

ビルド

$ npm run build

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

ローカルで実際のプレビュー

$ npm run serve

npm run buildの完了後にこのコマンドを実行する必要があります。このコマンドはローカルでbuildディレクトリをベースに静的サービスを起動し、http://localhost:3000/からアクセスできます。オンラインでの効果と完全に一致し、グローバル検索機能をサポートします。