Contribuisci

Grazie per aver espresso il tuo interesse a contribuire a PancakeSwap!

PancakeSwap è un progetto open-source. Se vuoi contribuire al progetto, questa sezione è qui per guidarti nei tuoi primi passi con il team di PancakeSwap 🥞

Prima di iniziare qualsiasi sviluppo, ti incoraggiamo vivamente a inviare una issue su Github per discutere il problema e la soluzione con il team.

Configura il tuo ambiente di sviluppo

Installa yarn se non lo hai già.

1. Fai un fork e clona il repository

   $ git clone [fork_repo_url]

2. Aggiungi il remote upstream. Ad esempio:

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

3. Assicurati di avere l'ultima versione del branch predefinito (develop)

   $ git checkout develop
   $ git pull upstream develop

4. Crea il tuo branch e installa le dipendenze

   $ git checkout -b branch-name
   $ yarn

5. Buona programmazione 🎉

Regole di codice

Cerchiamo di mantenere la massima coerenza possibile tra tutti i nostri repository. La tua pull request ha più possibilità di essere accettata se segui le regole seguenti e scrivi codice di alta qualità. Cominciamo 💪

Usa il UIKit

Controlla il UI Kit prima di iniziare qualsiasi cosa. Molti componenti sono già stati creati e non vogliamo che tu sprechi tempo a reinventare la ruota 😉

Se è necessario creare una variante di un componente, usa il componente corrispondente nel UI Kit come base. Ad esempio:

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

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

Usa gli strumenti!

La maggior parte dei nostri repo usa Typescript, ESLint e Prettier. Assicurati di conoscere le best practice di Typescript e di abilitare un plugin ESLint e Prettier per il tuo IDE.

Assicurati che il tuo codice sia formattato con Prettier e privo di errori ESLint prima di inviare una pull request.

Alcune buone pratiche

• Mantieni i componenti il più piccoli e "dumb" possibile.

• Usa la Composition over Inheritance.

• Tieni a mente che il tuo codice verrà letto e mantenuto da molti altri sviluppatori. Rendilo il più chiaro e facile da aggiornare possibile.​

Creare la tua pull request

Il tuo codice è pronto per essere inviato in revisione, congratulazioni 🥳

• Tutte le pull request devono avere una descrizione di ciò che la PR cerca di realizzare.

• Mantieni le pull request il più piccole possibile. Le pull request più grandi devono essere suddivise in parti più piccole con un branch base dedicato. Tagga con epic le PR che vengono unite nel tuo branch base.

• Se possibile, auto-rivedi la tua PR e aggiungi commenti dove è necessaria una spiegazione aggiuntiva.

Crea una draft PR il prima possibile così possiamo vedere il tuo progresso in corso.

Titolo della Pull Request

Il titolo delle nostre Pull Request segue i Conventional Commits usando commitlint.‌

Ulteriori dettagli nelle linee guida di Angular

Tipo	Descrizione
build	Modifiche che influenzano il sistema di build o le dipendenze esterne (es.: gulp, broccoli, npm)
ci	Modifiche ai file di configurazione CI e agli script (es.: Travis, Circle, BrowserStack, SauceLabs)
docs	Modifiche solo alla documentazione
feat	Una nuova funzionalità
fix	Una correzione di bug
perf	Una modifica al codice che migliora le prestazioni
refactor	Una modifica al codice che non corregge un bug né aggiunge una funzionalità
style	Modifiche che non influenzano il significato del codice (spazi bianchi, formattazione, punto e virgola mancante, ecc.)
test	Aggiunta di test mancanti o correzione di test esistenti

Grazie per aiutarci a rendere PancakeSwap ancora più straordinario ❤