Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 4.43 KB

Коллективное участие в проекте

Стиль

В курсе используются следующие стандарт кодирования:

Сообщить об ошибке

Если вы нашли ошибку не стесняйтесь сообщить об этом.

Чтобы сообщить об ошибке придерживайтесь следующих простых правил:

  • Проверьте раздел issues, чтобы не создавать дубликатов
  • Задайте понятный заголовок issues, лаконично и исчерпывающе определяющий проблему
    • постарайтесь не допускать двойного смысла, сленга и т.д.
  • Опишите сценарий воспроизведения ошибки или место в тексте, где она присутствует
    • скриншоты очень сильно помогают, но не заменяют сценарий
    • добавьте сообщение об ошибке (если это связано с кодом)
  • Опишите в чем заключается ошибка по вашему мнению
  • Опишите ожидаемое поведение или представление

Предложения по улучшению курса

Авторы приветствуют предложения по улучшению курса. Вы можете предложить:

  • новую тему для включения в курс;
  • пример кода;
  • полезную ссылку на интернет источник/обсуждение;
  • задание для самостоятельного решения;
  • литературу;
  • библиотеку;
  • и другой полезный материал.

Для внесения предложения по улучшению курса следуйте простым шагам:

  • Задайте понятный заголовок issue, лаконично и исчерпывающе определяющий Ваше предложение.
  • Укажите, что вы предлагаете: новую тему, пример, задание, ссылку и др.
  • Опишите суть предложения и обсудите в issue варианты реализации (для примера или задания), содержание (для темы), предоставляемые возможности (для библиотеки) и т.д.
  • Реализуйте Ваше предложение и предложите его через Pull request.

Добавление новых заданий

Вы можете добавить не только новые темы, примеры и ссылки, но и интересные задания для самостоятельного выполнения студентами. Для этого придерживайтесь следующих шагов:

  • Выберите директорию в python_pd/work наиболее подходящую к тематике вашего задания.
  • Создайте новую директорию в выбранной папке с коротким, но информативным названием.
  • Разместите описание задания в файле README.md.
  • При необходимости добавьте файл с входными данными с именем data и нужным расширением.
  • Разместите шаблон решения.
  • Добавьте набор тестов в файле с префиксом test_ для проверки правильности решения вашего задания.
  • Добавьте решение задачи в файл solution.py.

Директория с заданием должна иметь следующую структуру:

.
├── work
|   ├── new_task
|   |   ├── description.md
|   |   ├── new_task.py
|   |   ├── solution.py
|   |   ├── data.txt
|   |   └── test_new_task.py
.   .