В последнее время появилось очень много сообществ, ресурсов, материалов и везде есть что - то полезное.
В этой директиве в удобном формате хранятся:
- Полезные Youtube-каналы и блогеры
- Ценные документы и гайды
- Важные ресурсы и сайты
- Годные сообщества и паблики
- Качественные инструменты и фреймворки
В каждой папке есть набор текстовых файлов с кратким описанием чего-либо. Каждому файлу соответствует один источник. Это нужно для простоты поиска.
Прежде, чем читать инструкции ниже, прочтите правила оформления материалов
Я разработчик и/или понимаю, как пользоваться GitHub
-
Создать форк репозитория
-
Сделать ветку с названием статьи транслитом
-
Закинуть в нее папку с постом. Важно, чтобы название папки было уникальным, иначе произойдет обновление существующего поста (за раз можно добавить не более 10 файлов)
-
Создать PR
Мне нужна подробная инструкция
-
Создать отдельную ветку от main, в текстовом поле ввести название новой ветки, нажать на Create branch
-
Перейти в новую ветку и кликнуть Add file' => Upload files
-
Перетащить файл поста или папку с файлом в поле на новой странице. После успешной загрузки нажать зеленую кнопку Commit changes
- При создании нового поста важно, чтобы название папки было уникальным, иначе произойдет обновление существующего поста (за раз можно добавить не более 10 файлов)
-
Если все прошло успешно, то на экране появится соответствующее сообщение, в котором предлагается создать Pull Request. Кликаем зеленую кнопку Compare & pull request
-
В новом окне надо задать информацию о Pull Request. На данном этапе необязательно заполнять все как в последний раз, у вас еще будет возможно все отредактировать. После всех приготовлений кликаем зеленую кнопку Create pull request
-
В следующем окне отображается вся информация о вашем Pull Request, вы в любой момент можете его закрыть и вернуться позднее, прогресс не пропадет. Создание поста происходит после клика на кнопку Merge pull request
Для максимального удобства и качественной навигации следует придерживаться единого формата публикаций.
Шаблон оформления
При добавлении материал должен иметь следующую структуру:
# Заголовок: Опята.орг
## Строка-описание: Качественный сайт о грибах-опятах
![img](превью.png)
### Что это?
1-2 предложения о чём материал:
Опята.орг - набор ценных статей и ссылок различного спектра.
### Что ценного?
1-2 предложения о том, чем материал является/может являться особенным:
Самые обширные сведения об опятах среди бесплатных русскоязычных сайтов с минимумом рекламы.
### Кому подойдет?
1-2 предложения описывающих потенциальную аудиторию:
Любителям собирать и заготавливать на зиму грибы. Также, пишущим научные исследования о грибах.
### Ссылки
[ссылка 1](https://ссылка-1)
[ссылка 1](https://ссылка-2)
- Никакой рекламы/призывов к действию. Истинно ценные материалы не нуждаются в рекламе.
- Материал должен быть в отдельной папке. Каждая папка - в одном из ключевых разделов.
- Описание уместите в одну строку. Меньше лишних слов - лучше.
- Все последующие разделы постарайтесь уместить в 1-2 предложения. Логика та же.
- По изображениям желателен любой горизонтальный формат (
.jpg
,.png
,.jpeg
). Соотношение сторон между 4:3 и 16:9 либо приближенное - При необходимости добавить более одного изображения - помещать их после ссылок внизу отдельным разделом
В разделе issues можете заводить любые предложения по улучшению работы, структурированию данных, или стилизации.