Принос и участие в SubQuery

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Git Commit съобщения

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

JavaScript Styleguide

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