ChewySwap Docs
TelegramTwitterDEXStakeSwap
  • ℹ️ChewySwap Intro
    • πŸ‡ΊπŸ‡³Languages
    • πŸƒβ€β™‚οΈGet Started
      • πŸ‘œCreate a Wallet
      • πŸ–Get BONE for Gas
    • πŸ”KYC
    • πŸ”Audits
    • πŸ—ΊοΈRoadmap
  • 🦴Chewy Token
  • 🐢Connect to Shibarium
  • πŸ•Connect to Dogechain
  • ❔Frequently Asked Questions
  • πŸŽ‰Products
    • πŸ’±DEX Aggregator
      • How to Swap
      • Send Tokens
      • Price Ticker
    • Portfolio Tracker
    • πŸ”„Exchange
      • ↕️How to Swap
      • πŸ“ˆBuilt-In Charts
      • πŸ—ΊοΈFees and Routes
      • βš™οΈSettings / Slippage
      • ⚑Zap (V2)
      • πŸ”’Liquidity Pools
    • πŸ§‘β€πŸŒΎYield Farming
      • How to Use Farms
  • βš–οΈGovernance and Tokenomics
  • πŸ§‘β€πŸ€β€πŸ§‘Ambassador Program
  • 🀝Ecosystem & Partnerships
  • πŸ‘©β€πŸ’»Developers
    • 🌎Migrate from Marswap
    • πŸ› οΈResources for Builders
      • Dapp Boilerplate
    • πŸ‘Contributing
    • πŸš€Launching on ChewySwap
    • πŸ’ŽGempad
    • πŸ“„Smart Contracts
      • πŸ”„ChewySwap Exchange
      • πŸ‘¨β€πŸ³MasterChef
      • πŸ§ͺTestnet
    • πŸ§ͺTestnet Support
      • 🐢About Dogechain ZKEVM
      • πŸ”—Connecting
      • πŸ‘¨β€πŸ’»Developers
  • 🎬Media Kit
Powered by GitBook
On this page
  • Contributing
  • Setup your dev environment
  • Coding rules
  • Use the UIKit
  • Use the tools!
  • Creating your pull request

Was this helpful?

Edit on GitHub
  1. Developers

Contributing

PreviousDapp BoilerplateNextLaunching on ChewySwap

Last updated 1 year ago

Was this helpful?

Contributing

Thank you for expressing your interest in contributing to ChewySwap!

ChewySwap 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 ChewySwap 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.

Setup your dev environment

Install If you haven't.

  1. 1.Fork and clone the ​ git clone [fork_repo_url]

  2. 2.Add remote. E.g. git remote add upstream git@github.com:pancakeswap/pancake-frontend.git

  3. 3.Make sure you have the latest version of the default branch ( develop ) git checkout develop$ git pull upstream develop

  4. 4.Create your own branch and install dependencies git checkout -b branch-name yarn

  5. 5.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 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/uikit'
​
const NewButtonVariant = styled(Button)`// custom styles here`

Use the tools!

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.​

Creating your pull request

Your code is ready to be submitted for review, congratulationsπŸ₯³

  • 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.

Pull Request Title

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

Thanks for helping us making ChewySwap even more awesome ❀

Most of our repos use , , and . Make sure you're familiar with Typescript’s best practices and enable an ESLint and Prettier plugin for your IDE.Make sure your code is formatted with Prettier and is free from any ESLint error before you submit a pull request.

Keep components as small and as possible.

Use .

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

Our Pull Request Title follow using .β€Œ More at ​

πŸ‘©β€πŸ’»
πŸ‘
yarn
repository
upstream
UI Kit
Typescript
ESLint
Prettier
"dumb"
Composition over Inheritance
draft PR
Conventional Commits
commitlint
Angular's guidelines