Принос към SubQuery

Добре дошли и ви благодаря, че обмисляте да допринесете за този SubQuery проект! Заедно можем да проправим пътя към по-децентрализирано бъдеще.

Тази документация се поддържа активно от екипа на SubQuery. Приветстваме вашия принос, можете да го направите, като форкнете нашия GitHub проект и направите промени във всички файлове с намалена документация в директорията с документи.

Това, което следва, е набор от насоки (не правила) за принос към SubQuery. Следването на тези указания ще ни помогне да направим процеса на принос лесен и ефективен за всички участващи. Той съобщава, че се съгласявате да уважавате времето на разработчиците, които управляват и разработват този проект. В замяна ние ще отвърнем на това уважение, като разгледаме проблема ви, ще разгледаме промените, ще си сътрудничим за подобрения и ще ви помогнем да финализирате заявките си за изтегляне.

Кодекс на поведение

Ние приемаме нашите обществени проекти с отворен код сериозно и държим себе си и другите участници, както и имаме високи стандарти за комуникация. Като участвате и допринасяте за този проект, вие се съгласявате да спазвате нашия Кодекс за поведение (opens new window).

Нека да започнем

Приносът към нашите хранилища се прави чрез проблеми и заявки за изтегляне (Pull Requests - PR). Няколко общи насоки, които обхващат и двете:

• Потърсете съществуващи проблеми и заявки за изтегляне, преди да създадете свои собствени.
• Работим усилено, за да гарантираме, че проблемите се решават бързо, но в зависимост от въздействието може да отнеме известно време, за да се проучи основната причина. Приятелското @ споменаване в коментарите към подателя или сътрудника, може да ви помогне да привлечете внимание, в случай че проблемът ви блокира.

Как да допринесете

Докладване на грешки

Грешките се проследяват като проблеми с GitHub. Когато регистрирате проблем, обяснете проблема и включете допълнителни подробности, за да помогнете на съпорта да възпроизведе проблема:

• Използвайте ясно и описателно заглавие на проблема, за да идентифицирате проблема.
• Опишете точните стъпки за възпроизвеждане на проблема.
• Опишете поведението, което наблюдавате, след като следвате стъпките.
• Обяснете какво поведение сте очаквали да видите вместо това и защо.
• Включете снимки на екрана, ако е възможно.

Подаване на заявки за изтегляне

Като цяло следваме работния процес на Git "Fork-and-pull"

• Форкнете хранилището към вашия собствен акаунт в Github
• Клонирайте проекта на вашата машина
• Създайте локален клон с кратко, но описателно име
• Извършете промени в клона
• Следвайте всички указания за форматиране и тестване, специфични за това репо
• Направете промените във вашият форк
• Отворете заявка за изтегляне в нашето хранилище

Правила за кодиране

Git Commit съобщения

• Използвайте сегашно време („Добавяне на функция“, а не „Добавена функция“)
• Използвайте повелителното наклонение („Премести курсора към...“, а не „Преместване на курсора към...“)
• Ограничете първия ред до 72 знака или по-малко

JavaScript Styleguide

• Целият JavaScript код е подреден с Prettier и ESLint