Репозиторий содержит примеры использования инструмента управления архитектурой DocHub. Репозиторий развивается силами сообщества.
- Накопление опыта использования инструмента;
- Развитие практик применения DocHub;
- Формирование базы знаний для создания прикладных метамоделей.
- Установите IntelliJ IDEA. Рекомендуется Community Edition;
- Установите плагин DocHub;
- Клонируейте репоизиторий примеров:
git clone https://github.com/rpiontik/DocHubExamples.git
- Откройте в IDE каталог DocHubExamples;
- Найдите справа в панели плагинов закладку DocHub и откройте ее;
- Откройте файл ./dochub.yaml и раскомментируйте нужный пример;
- Сохраните файл;
- Следуйте рекомендациям примера;
- Наблюдайте изменения в рендеринге плагина DocHub справа.
Чтобы сделать вклад в репозиторий, необходимо:
- Создать форк данного репозитория;
- Внести изменения:
- в папке ./src создать папку примера (Например, ./src/C4ModelContext);
- в папке примера создать файл README.md, где описать суть примера;
- корневым файлом примера должен быть dochub.yaml;
- папку примера наполнить контентом примера;
- в корневой файл ./dochub.yaml добавить закомментированную строку импорта примера. Например:
imports: ... # Пример пользовательского контекста # - ./src/C4ModelContext/dochub.yaml
- внести изменения в файл ./README.md в раздел "Каталог".
- Создать Pull Request в master ветку данного репозитория.
- Пример должен быть структурирован, структура файлов продумана, читабельна;
- Код архитектуры должен быть снабжен комментариями;
- Названия файлов должны быть на латинице и не должны содержать пробелы;
- Настоятельно рекомендуется избегать внешних ссылок кроме случаев, когда они являются сутью примера;
- Данные для примера должны содержаться в самом примере;
- Рекламные ссылки запрещены без предварительного согласования.
- Старайтесь в примере погружать читателя в смысл последовательно, предполагая, что он плохо знаком с инструментом;
- Если для понимания примера нужна подготовка, укажите это явно, давайте ссылки на нужный материал;
- Сопровождайте пример ссылками на документацию;
- В README.md включайте наглядные изображения ожидаемого от примера результата.
- Оставляйте информацию о найденных ошибках, опечатках и прочих отклонениях помечая меткой "bug";
- Размещайте запросы на примеры как "requests";
- Идеи оставляйте с меткой "idea".
Все материалы содержащиеся в данном репозитории являются публичными. Могут использовать без ограничения с любой целью не противоречащей закону.
Pull request в данный репозиторий означает согласие автора на присоединение к данной лицензии.
The MIT License http://opensource.org/licenses/MIT