贡献指南

感谢你对为 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. 开始愉快地编码吧 🎉

编码规则

我们尽力在各个代码仓库之间保持尽可能多的一致性。如果你遵循以下规则并编写高质量的代码，你的 pull request 被接受的机会会更大。让我们开始吧 💪

使用 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 插件。

在提交 pull request 之前，请确保你的代码已使用 Prettier 格式化，并且没有任何 ESLint 错误。

一些良好实践

• 让组件尽可能小且"简单"。

• 使用组合优于继承。

• 请记住，你的代码将被其他几位开发者阅读和维护。请让它尽可能清晰、易于更新。​

创建你的 pull request

你的代码已准备好提交审核，恭喜🥳

• 所有 pull request 必须包含对该 PR 试图实现目标的描述。

• 让 pull request 尽可能小。较大的 pull request 应拆分为更小的部分，并使用专门的基础分支。请为合并到你基础分支的 PR 打上 epic 标签。

• 如有可能，请自我审查你的 PR，并在需要进一步说明的地方添加注释。

请尽快创建草稿 PR，以便我们查看你的实时进度。

Pull Request 标题

我们的 Pull Request 标题遵循 Conventional Commits 规范，并使用 commitlint。‌

更多内容请见 Angular 的指南

类型	描述
build	影响构建系统或外部依赖的更改（示例范围：gulp、broccoli、npm）
ci	对我们 CI 配置文件和脚本的更改（示例范围：Travis、Circle、BrowserStack、SauceLabs）
docs	仅文档相关的更改
feat	新功能
fix	错误修复
perf	提升性能的代码更改
refactor	既不修复错误也不添加功能的代码更改
style	不影响代码含义的更改（空格、格式、缺少分号等）
test	添加缺失的测试或修正现有测试

感谢你帮助我们让 PancakeSwap 变得更加出色 ❤