Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 5.92 KB

CONTRIBUTING.md

File metadata and controls

91 lines (57 loc) · 5.92 KB

Помощь проекту

Мы очень ценим любую помощь проекту и всячески приветствуем ее! Вы можете помочь любым из перечисленных ниже способов.

Написать отчёт об ошибке

Пожалуйста, сообщайте об ошибках, используя GitHub Issues.

Если вы сообщаете об ошибке, пожалуйста, укажите:

  • название и версию вашей операционной системы;
  • название и версию вашего браузера;
  • любые сведения о ваших локальных настройках, которые могут оказаться полезными в локализации ошибки;
  • подробные шаги по воспроизведению ошибки;
  • информацию для исправление ошибки.

Исправить ошибку

Просмотрите список GitHub Issues на предмет ошибок. Любое сообщение, помеченное как "ошибка" ("bug") и "требуется помощь" ("help wanted"), открыто для всех желающих помочь с исправлением.

Реализовать новую функцию

Просмотрите список GitHub Issues на предмет запроса обновлений. Любое обращение, помеченное как ("enhancement") и "требуется помощь" ("help wanted"), открыто для всех желающих помочь с реализацией.

Добавить новую статью, пример кода, иллюстрацию

Если вы владеете полезной информацией и желаете поделиться ей, просто сделайте это. Возможность добавлять полезные материалы открыта для всех желающих.

Оставить отзыв или предложить идею

Лучший способ отправить отзыв — это опубликовать сообщение на GitHub Issues.

Если вы предлагаете функцию:

  • подробно объясните, как она будет работать;
  • постарайтесь максимально конкретизировать описание, чтобы упростить реализацию;
  • помните, что это проект, управляемый добровольцами, и что любая помощь приветствуется.

Если вы предлагаете новый материал:

  • убедитесь, что предлагаемый материал еще никто не добавил;
  • добавьте материал.

Внести вклад в проект

Готовы внести свой вклад? Следуйте инструкциям ниже, чтобы внести свой вклад в проект.

Простые правки

Если вы хотите сделать простую правку (исправить опечатку или добавить небольшую заметку), то это можно сделать непосредственно через GitHub. Краткая инструкция:

  1. Форкаете репозиторий: для этого нужно нажать кнопку Fork в правом верхнем углу с любой страницы репозитория.
  2. Переходите к себе в профиль, там у вас будет форк репозитория. Переходите в него, выбираете нужную страничку кликаете на карандаш вверху справа (edit this file).
  3. Редактируете файл, сохраняете изменения.
  4. На странице с вашим форком появится большая зелёная кнопка «New Pull Request». Нажимаете её и создаёте Pull Request.

Сложные правки

Если вы хотите сделать сложную правку (например, поправить шаблон, добавить статью), то лучше бы это сделать на локальной машине, проверить, что всё работает, а только после этого сделать Pull Request. Если вы не знакомы с системой контроля версий git, то можно начать со следующей статьи: Pull request'ы на GitHub или Как мне внести изменения в чужой проект, суть которой сводится к следующему:

  1. Форкните репозиторий на GitHub.
  2. Клонируйте свой форк на локальный компьютер.
  3. Установите зависимости проекта в свое локальное виртуальное окружение, например, используя pip.
  4. Создайте ветку для локальной разработки и вносите изменения локально.
  5. Зафиксируйте свои изменения и разместите свою ветку на GitHub.
  6. Отправьте Pull Request через веб-сайт GitHub.

Нормы поведения

Пожалуйста, обратите внимание, что проект BookSeer придерживается Кодекса поведения участников. Внося свой вклад в этот проект, вы соглашайтесь соблюдать его условия.