貢献する

PancakeSwapへの貢献に興味を持っていただきありがとうございます！

PancakeSwapはオープンソースプロジェクトです。プロジェクトに貢献したい方のために、このセクションではPancakeSwapチームとの最初のステップをガイドします 🥞

開発を始める前に、問題と解決策についてチームと議論するためにGithubでIssueを提出されることを強くお勧めします。

開発環境のセットアップ

yarnがインストールされていない場合はインストールしてください。

1. リポジトリをForkしてクローンします

   $ git clone [fork_repo_url]

2. upstreamリモートを追加します。例：

   $ git remote add upstream [e-mail]:pancakeswap/pancake-frontend.git

3. デフォルトブランチ（develop）の最新版を取得します

   $ git checkout develop
   $ git pull upstream develop

4. 自分のブランチを作成して依存関係をインストールします

   $ git checkout -b branch-name
   $ yarn

5. コーディングをお楽しみください 🎉

コーディングルール

各リポジトリ間でできる限り一貫性を保つよう努めています。以下のルールに従い、高品質なコードを書くことでプルリクエストが承認される可能性が高まります。始めましょう 💪

UIKitを使用する

作業を始める前にUI Kitを確認してください。多くのコンポーネントがすでに作成されており、車輪の再発明に時間を無駄にしてほしくありません 😉

コンポーネントのバリアントを作成する必要がある場合は、UI Kitの対応するコンポーネントをベースとして使用してください。例：

import styled from 'styled-components'
import { Button } from '@pancakeswap/uikit'

const NewButtonVariant = styled(Button)`
  // custom styles here
`

ツールを使おう！

ほとんどのリポジトリではTypescript、ESLint、Prettierを使用しています。Typescriptのベストプラクティスに精通し、IDEにESLintとPrettierのプラグインを有効化してください。

プルリクエストを提出する前に、コードがPrettierでフォーマットされており、ESLintエラーがないことを確認してください。

良いプラクティス

• コンポーネントはできる限り小さく"ダム"に保ってください。

• 継承より合成を使用してください。

• 自分のコードが他の複数の開発者に読まれ、メンテナンスされることを念頭に置いてください。できる限り明確でアップデートしやすいコードにしましょう。​

プルリクエストの作成

コードのレビュー提出準備ができました、おめでとうございます 🥳

• すべてのプルリクエストにはPRが達成しようとしていることの説明が必要です。

• プルリクエストはできる限り小さく保ってください。大きなプルリクエストは専用のベースブランチを持つ小さなチャンクに分割してください。ベースブランチへマージするPRにはepicタグを付けてください。

• 可能であれば自分でPRをレビューし、追加の説明が必要な箇所にはコメントを追加してください。

できるだけ早くドラフトPRを作成して、進行状況を確認できるようにしてください。

プルリクエストのタイトル

プルリクエストのタイトルはcommitlintを使用したConventional Commitsに従います。‌

詳細は Angularのガイドラインを参照してください

タイプ	説明
build	ビルドシステムまたは外部依存関係に影響する変更（スコープの例：gulp、broccoli、npm）
ci	CIの設定ファイルやスクリプトの変更（スコープの例：Travis、Circle、BrowserStack、SauceLabs）
docs	ドキュメントのみの変更
feat	新機能
fix	バグ修正
perf	パフォーマンスを改善するコード変更
refactor	バグの修正でも新機能の追加でもないコード変更
style	コードの意味に影響しない変更（空白、フォーマット、セミコロンの欠落など）
test	テストの追加または既存のテストの修正

PancakeSwapをさらに素晴らしいものにするためにご協力いただきありがとうございます ❤