common_core

С чего начать?

Для того чтобы облегчить знакомство с сервисом GitFlic и первые шаги в нём, мы подготовили несколько рекомендаций.
Уже опытный пользователь? Просто отредактируйте данный README файл по своему усмотрению.
Не знаете что добавить в него? Перейдите в раздел "Что должен содержать README файл", в котором описаны ключевые компоненты хорошего README файла.

Добавьте свои файлы

Если вы решили начать разработку проекта с создания репозитория в нашем сервисе, тогда клонируйте себе данный репозиторий следующим образом:

git clone https://gitflic.ru/project/virtplace/common_core.git
cd common_core
**добавьте первые файлы вашего проекта**
git add .
git commit -m "Initial commit"
git push -u origin master

Уже что-то делали в проекте? В таком случае инициализируйте гит-репозиторий в корне проекта и добавьте текущий репозиторий как удалённый репозиторий:

cd existing_folder
git init
git remote add origin https://gitflic.ru/project/virtplace/common_core.git
git clone
 ***добавьте новые файлы***
git add .
git commit -m "Новый коммит"
git push -u origin master

Что должен содержать README файл

Прежде всего, стоит понимать, что README.md — это краткая документация. Это первое, что видит человек, который открывает репозиторий. Поэтому здесь важно дать достаточно информации о проекте и рассказать, что он из себя представляет. Ключевая информация, которую должен содержать README файл:

Название и описание

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

Установка и настройка

Также в README файле рекомендуется перечислить необходимые инструкции для установки, будь то использование пакетных менеджеров (например, Homebrew на MacOS или apt на Linux), зависимости, которые могут понадобиться в ходе использования, а также шаги по их настройке.

Contributing

Можно добавить информацию о том, как принять участие в разработке вашего проекта, как стать непосредственным участником, правила оформления pull-requests и т.д.

Контакты

Ссылки на внешние ресурсы, такие как документация, блог, страница проекта в социальных сетях, сообщество проекта и т.д.

Статус проекта

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

Полезные ссылки

Работа с проектом

• [ ] Как создать проект
• [ ] Как импортировать проект
• [ ] Запросы на слияние
• [ ] Зеркалирование проекта
• [ ] Импортировать проект с GitLab

Команды

• [ ] Создание команды
• [ ] Обзор команды
• [ ] Настройка команды

Реестр пакетов

• [ ] Реестр пакетов
• [ ] PyPi
• [ ] Generic
• [ ] Maven
• [ ] Docker

Компании

• [ ] Создание компании
• [ ] Обзор компании
• [ ] Тарифы и оплата
• [ ] Запуск агента компании

CI/CD

• [ ] Что такое GitFlic CI/CD
• [ ] Задача (Job)
• [ ] Конвейер (pipeline)
• [ ] Агенты
• [ ] Справочник для .yaml файла

API

• [ ] Введение в GitFlic API
• [ ] Методы для администратора
• [ ] Получение access токена

Панель администратора

• [ ] Панель администратора
• [ ] Панель управления
• [ ] Настройка LDAP
• [ ] Ключевые настройки

Общая информация

• [ ] Глоссарий
• [ ] Права доступа ролей
• [ ] Вебхуки