Вклад

Мы ценим ваш вклад! Мы стремимся сделать процесс вклада в этот проект максимально простым и прозрачным. Если вы хотите внести свой вклад, пожалуйста, сначала обсудите изменения, которые вы хотите внести, через issue, электронную почту, контактную форму на https://baserow.io/contact или любым другим способом. Если вы не знаете, чем можно внести вклад, пожалуйста, отправьте нам краткий обзор вашего опыта и, при желании, что вы хотели бы изучить. Мы ответим вам как можно скорее с предложенными задачами.

Мы разрабатываем с использованием GitLab

Мы используем GitLab для хранения кода, отслеживания задач и создания запросов на новые функции. Официальный репозиторий можно найти на https://gitlab.com/baserow/baserow/. Существует зеркальный репозиторий на GitHub, но это не официальный репозиторий.

Процесс запросов на слияние

1. Откройте новый запрос на новую функцию/изменение/ошибку, выбрав соответствующий тип задачи при создании задачи, или прокомментируйте существующую задачу.
2. Предложите свои планы и обсудите их с сообществом в задаче.
3. Создайте вилку репозитория и создайте ветку от develop.
4. Внесите изменения, описанные в задаче.
5. Убедитесь, что ваш код соответствует стандартам качества.
6. Отправьте свой запрос на слияние!
7. Обычно мы включаем следующие опции слияния в GitLab:
   1. "Удалить исходную ветку при принятии запроса на слияние."
   2. "Сжать коммиты при принятии запроса на слияние."
8. Модератор рассмотрит ваш код и объединит его.

Стандарты качества

• Код бэкенда должен иметь юнит-тесты.
• Код Python должен соответствовать стандарту PEP 8.
• Документация в коде Python должна быть в стиле reStructured.
• Код SCSS должен соответствовать BEM.
• Код JavaScript должен соответствовать правилам eslint:recommended.
• В коде требуется документация для каждой функции или класса, которые не являются очевидными.
• Документация для каждого концепта, который может быть использован плагином.
• Должен быть сгенерирован новый файл записи в changelog с помощью скрипта, находящегося в папке changelog.
• Конвейер должен проходить успешно.
• Попробуйте применить правило десяток: MR должны стремиться иметь не более 10 файлов кода с более чем 10 измененными строками. Файл кода не включает тесты/css/текст/миграции/переводы/конфигурацию и т.д.

Любые ваши вклады будут под MIT Лицензией на программное обеспечение

Кратко говоря, когда вы отправляете изменения в код, ваши изменения считаются подпадающими под ту же MIT Лицензию, которая покрывает проект. Если у вас есть какие-либо опасения по этому поводу, пожалуйста, свяжитесь с нами.

Отчеты об ошибках

Мы используем задачи GitLab для отслеживания публичных ошибок. Вы можете сообщить об ошибке, открыв новую задачу на https://gitlab.com/baserow/baserow/-/issues и выбрав тип задачи Bug. Вы также можете отправить ошибку нам по электронной почте или через контактную форму на https://baserow.io/contact, если предпочитаете.

Хорошие отчеты об ошибках обычно содержат:

• Краткое резюме и/или контекст.
• Шаги для воспроизведения.
  • Будьте конкретны!
  • Приведите пример кода, если возможно.
• То, что вы ожидали увидеть.
• То, что происходит на самом деле.
• Примечания (возможно, почему вы считаете, что это может происходить, или что вы пробовали, но что не сработало).

Люди любят тщательные отчеты об ошибках.

Уязвимости

Если вы обнаружили уязвимость в Baserow, мы будем признательны, если вы сообщите нам по электронной почте или через контактную форму на https://baserow.io/contact вместо публичного сообщения, так как уязвимость может потребовать первоочередного решения.

Обновление документации

Документацию Baserow можно обновить, редактируя файлы Markdown в директории docs. Мы используем спецификацию CommonMark и библиотеку markdown-it для рендеринга. В настоящее время сайт документации нельзя предварительно просмотреть, используйте совместимый редактор Markdown для проверки изменений.