PancakeSwap
Launch App
Русский
Русский
  • PancakeSwap
  • Обратная связь
    • Деловые отношения
    • Служба поддержки клиентов
    • Социальные сети и сообщества
  • Нажмите здесь, чтобы получить необходимую помощь
    • Устранение неисправностей и Ошибки
    • Часто задаваемые вопросы
    • Binance Academy Руководство по PancakeSwap
      • How to use PancakeSwap with Trust Wallet
    • Подключение MetaMask к Binance Smart Chain
  • Завершение поддержки veCAKE
    • Обмен ставленного CAKE
  • Roadmap
  • Products
    • Exchange
      • Liquidity Pools and Adding Liquidity
      • How to Trade on the PancakeSwap Exchange
    • Yield Farming
      • How to Yield Farm on PancakeSwap
      • Farms
    • Syrup Pools
      • Syrup Pools
    • Lottery
      • Lottery
      • How to Take Part in the PancakeSwap Lottery
      • Lottery FAQ
    • IFO (Initial Farm Offering)
      • IFO (Initial Farm Offering)
    • Info
      • Analytics
    • Voting
      • What is voting?
      • How to vote with SafePal wallet
  • Tokenomics
    • CAKE
      • Controlling CAKE supply
        • SYRUP (deprecated)
  • Development Guide
    • Contributing
      • Codebase Overview
Powered by GitBook
On this page
  • Setup your dev environment
  • Coding rules
  • Committing
  • Creating your pull request

Was this helpful?

  1. Development Guide

Contributing

Thank you for expressing your interest in contributing to PancakeSwap !

PreviousSYRUP (deprecated)NextCodebase Overview

Last updated 4 years ago

Was this helpful?

Pancake is an open-source project. If you want to contribute to the project, this section is here to guide you through your first steps with the Pancake team

Before starting any development, we highly encourage you to submit an issue on Github in order to discuss the problem, and the solution with the team. If you want to reach out to the dev team directly, contact @chef_chungus on Telegram

Setup your dev environment

  1. Fork the repository and an . E.g.

    $ git remote add upstream git@github.com:pancakeswap/pancake-frontend.git
  2. Make sure you have the latest version of the default branch ( develop or master )

    $ git checkout develop
    $ git pull upstream develop
  3. Create your own branch and install dependencies

    $ git checkout -b branch-name
    $ yarn
  4. Happy coding

Coding rules

We try to maintain as much consistency as we can between each of our repository. Your pull request has more chances to be accepted if you follow some the following rules, and write high quality code. Let's get started

Use the UIKit

Check the before you start doing anything. A lot of components are already created, and we don't want that you waste your time reinventing the wheel

If a variant of a component needs to be created, use the corresponding component in the UI Kit as a base. For example:

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

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

Use the tools !

Make sure your code is formatted with Prettier, and is free from any ESLint error before you submit a pull request.

Some good practices

  • Keep in mind that your code will be read and maintained by several other developers. Make it as clear and easy to update as possible.

Committing

Type

Description

build

Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

ci

Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

docs

Documentation only changes

feat

A new feature

fix

A bug fix

perf

A code change that improves performance

refactor

A code change that neither fixes a bug nor adds a feature

style

Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

test

Adding missing tests or correcting existing tests

Creating your pull request

  • All pull requests must have a description of what the PR is trying to accomplish.

  • Keep pull requests as small as possible. Larger pull requests should be broken up into smaller chunks with a dedicated base branch. Please tag the PR's that are merging into your base branch with the epic tag.

  • If possible self-review your PR and add comments where additional clarification is needed.

Most of our repos use , , and . Make sure you are familiar with Typescript’s best practices, and enable an ESLint and Prettier plugin for your IDE.

Keep components as small and as possible.

Use .

Our commit messages follow using .‌

More at ​

Your code is ready to be submitted for review, congratulations

Create a as soon as possible so we can view your ongoing progress.

Thanks your for helping us making Pancake even more awesome

🥳
❤️
Typescript
ESLint
Prettier
"dumb"
Composition over Inheritance
Conventional Commits
commitlint
Angular's guidelines
draft PR
🥞
🎉
💪
😉
add upstream remote
UI Kit