Участие в разработке

Спасибо за интерес к участию в развитии PancakeSwap!

PancakeSwap — проект с открытым исходным кодом. Если ты хочешь внести вклад в проект, этот раздел поможет тебе сделать первые шаги совместно с командой PancakeSwap 🥞

Прежде чем приступать к разработке, мы настоятельно рекомендуем открыть issue на Github, чтобы обсудить проблему и решение с командой.

Настройка среды разработки

Установи yarn, если он ещё не установлен.

1. Сделай форк и клонируй репозиторий

   $ 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, и установи плагины ESLint и Prettier для своей IDE.

Перед отправкой 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 ещё лучше ❤