best-practices.adoc

Лучшие практики

Добро пожаловать на страницу лучших практик для git, разработки исследовательского программного обеспечения и управления исследовательскими данными. Этот документ был создан для исследователей и сотрудников Ярославского государственного университета им. П.Г. Демидова. Мы настоятельно рекомендуем делиться здесь лучшими практиками с коллегами.

Темы

Использование Git и GitHub

Git — это бесплатное программное обеспечение с открытым исходным кодом для управления версиями. Оно было создано в 2005 году и сегодня является стандартом в области контроля версий при разработке программного обеспечения. GitHub — это онлайн-сервис на базе Git, который облегчает совместную работу и взаимодействие группы разработчиков. Также он может использоваться для резервного копирования локальной работы. Изучение Git и GitHub в начале может показаться сложным, но поверь, это того стоит.

Быстрый старт

1. Создай аккаунт на GitHub.

2. Скачай и установи GitHub Desktop.

3. Добавься в GitHub-организацию ЯрГУ (опционально).

4. Создай свой первый репозиторий с Github Desktop.

Дополнительная информация

• Что такое GitHub и как он работает.

• Изучи как использовать GitHub с помощью интерактивных курсов, как для новичков и для экспертов.

Код в стиле FAIR

FAIR-данные — это данные, соответствующие принципам Findability, Accessibility, Interoperability, Reusability (находимость, доступность, совместимость и переиспользование). Акроним FAIR можно также перевести как «честные», «справедливые». Указанные принципы были представлены в мартовской статье 2016 года в журнале Scientific Data консорциумом из нескольких ученых и организаций. В настоящее время принципы FAIR широко используемым в управлении исследовательскими данными. Недавно принципы FAIR были адаптированы к исследовательскому программному обеспечению.

Быстрый старт

• Пять рекомендаций для программного обеспечения FAIR (fair-software.eu).

Инструменты

• Python-пакет для анализа соответствия репозитория на GitHub или GitLab рекомендациям fair-software.eu.

Дополнительно

• Статья о принципах FAIR для программного обеспечения: Towards FAIR principles for research software (2020).

• Статья о принципах FAIR для данных: The FAIR Guiding Principles for scientific data management and stewardship (2016).

• Рабочая группа FAIR for Research Software (FAIR4RS) https://www.rd-alliance.org/groups/fair-research-software-fair4rs-wg.

Наглядность

Чтобы другие могли легко использовать твои выдающиеся работы, они должны иметь возможность найти и тебя, и твои проекты. Платформа GitHub предоставляет множество возможностей сделать твоё исследовательское программное обеспечение более заметным.

Быстрый старт

• Заполни информацию о себе и добавь README в профиль своего GitHub-аккаунта.

• Добавь упоминание своего GitHub-профиля на странице сотрудника в cris.uniyar.ac.ru.

• Добавь топики к своему репозиторию для улучшения поиска по темам. Для упоминания нашего университета рекомендуется использовать топик #uniyar.

Дополнительно

• Используй Github Pages для публикации сайта проекта с ссылками на все соответствующие репозитории и указанием профилей участников.