Открытый исходный код, способствующий (2 части серии)
Быстрая примечание: Я создаю совершенно новое сообщество для разработчиков, ориентируясь на навыки строительства программирования, посредством приветственной среды онлайн-совместной работы. Нам нужны разработчики, такие как вы, так что рассмотреть присоединяясь к нам !
Процесс превращения репозитория в проект с открытым исходным кодом, который может принять участок от общественности, требует тщательного планирования. Есть некоторые предметы, которые в идеале должны быть включены в каждый репозиторий, чтобы помочь ему под контроль.
Мы пройдемся по основным элементам, каждый репозиторий с открытым исходным кодом должен иметь прежде, чем сделать его публикой. Создайте контрольный список этих элементов для каждого репозитория, который вы планируете запустить или обновлять свои существующие, если какие-либо элементы отсутствуют.
По моему опыту до сих пор поддерживает репозитории с открытым исходным кодом на Assirezone Github Page Я обнаружил, что каждый из этих элементов контрольного списка на месте чрезвычайно полезным. Проверка этих элементов выключена для каждого репозитория, безусловно, сделает процесс сохранения для вас!
Это должно быть полезно для того, чтобы кто-то думал о запуске хранилища открытого исходного кода или если вы хотите более эффективно управлять своими существующими.
Файл readme.md, размещенный в корневой папке, является минимальной формой документации, необходимой для каждого репозитория. Значение по его названию, файл readme содержит информацию, которая должна прочитать, кто-нибудь просматривает репо. Содержимое README должно содержать такие детали, как:
- Описание того, о чем репо
- Технологии, библиотеки и рамки используются
- Как установить и использовать содержимое репо
- Текущее состояние репо
- Любая другая важная информация, которую вы хотите, чтобы читатель узнал
Файл readme — это первый элемент в этом контрольном списке по причине; Это, вероятно, самая важная форма документации для любого репо. Если у вас нет других предметов на этом контрольном списке, убедитесь, что вы хотя бы у вас есть этот!
Файл Promainting.md является еще одной формой документации. Он отличается от Readme, поскольку вклад вклад вклад в действие все необходимые для всех, кто хочет внести свой вклад в РЕПО.
Поскольку это все о том, как внести свой вклад в REPO, файл должен иметь детали, такие как:
- Какой вклад вы принимаете, например, Исправления ошибок, Улучшения, Обновления документации и т. Д…
- Инструкции по подаче вклад E.g. Отправляя запрос на тягу
- Руководящие принципы для подаваемого кода E.g. Правила льмина, именование файлов, переменные соглашения о именах и др…
- Любые другие инструкции или рекомендации, которые вы хотите, чтобы вкладчик следовать
Это файл, в котором вы действительно можете добраться до уровня детализации точно, какие правила следует соблюдать. Я бы сказал, что вклад вклад файл, вероятно, устанавливает стандарт того, как люди будут просматривать ваши репо.
Если у вас нет файла вклад в свой вклад, это действительно что-нибудь, и вам нечего будет иметь значение, если кто-то подает запрос на тягу, который не до стандарта.
Тем не менее, если вы подробные четкие инструкции по вкладам вклад, вы всегда можете указать вклад в файл, если кто-либо представляет ничего не до стандарта. GitHub даже предлагает пользователям прочитать файл вклад в действие, когда они посещают страницы репо, что указывает, что они могут захотеть внести свой вклад.
Имейте в виду, некоторые люди, которые хотят внести свой вклад, могут быть новичками для открытия источника и GitHub. Поэтому убедитесь, что инструкции достаточно ясны для детализации, что нужно сделать.
Вкладной файл, вероятно, является вторым наиболее важным после файла README. Поэтому не бойтесь укладывать правила и детали, чтобы установить стандарт для вкладов, которые помогут сохранить репо в порядке.
Чтобы быть четкой из лицензирования условий вашего репозитория, просто добавьте файл называемый лицензией. Большинство репозиториев с открытым исходным кодом будут использовать лицензию, позволяющую кому-либо использовать и изменить содержимое репо, как они пожелают.
Если вы хотите дать людям свободу делать то, что они, пожалуйста, такая лицензия, как MIT, которая должна делать то, что я люблю использовать для моего репо
Однако, если вы хотите разместить некоторые ограничения на то, что другие могут сделать с вашим кодом, обязательно выполните исследование и поместите соответствующие условия лицензирования. GitHub имеет ряд лицензий, которые вы можете легко добавить в ваш репо. Для получения дополнительной информации см. Github Docs по лицензированию репозитория Отказ
«Вопросы» Это раздел в каждом репозитории GitHub, который действует как проект для любого задания или обсуждения, связанного с этим репозиторий. Любой может представить проблему на репо. Общие вопросы, созданные на REPOS, могут включать в себя: отчетность об ошибке, предлагая повышение или задание вопроса относительно репо.
Совет по вопросам является прекрасным способом отслеживания всех произведений и предложений, связанных с репозиторием. Это также может выйти из-под контроля, если не удалось хорошо!
Лучший способ держать вещи под контролем — заставить кого-нибудь создавать проблему для использования Выдавать шаблоны Отказ Смотрите Github Docs On Рекомендации по шаблонам выпуска О том, как создавать эти шаблоны. Также не стесняйтесь использовать шаблоны выпуска, используемые любым из наших Inspirezone Github Repos Отказ
Шаблоны выпуска предоставляют установочный формат для использования вкладчиков, когда они нажимают на создание Кнопка выпуска на репо. Вы также можете установить несколько шаблонов выпуска, чтобы соответствующий шаблон можно выбрать в зависимости от типа сообщенного выпуска. Шаблоны также позволяют выполнять автоматические действия в зависимости от того, какой выпуск создается. Например, если проблема ошибки сообщается, вы можете автоматически назначить его кому-либо.
Преимущество использования шаблонов позволит вам контролировать типы вопросов, которые можно отправить и запросить конкретную информацию, когда кто-либо создает вопрос.
Например, вы можете убедиться, что ошибки сообщают, будут подробно описаны вам информацию о целях отладки, такие как: ОС Устройства, версия программного обеспечения, шаги для воспроизведения и т. Д.
Наличие шаблонов выпуска, установленные на месте, это один из способов того, чтобы гарантировать, что борту выпусков в репо было легче сканировать и фильтровать, а также выполнять вашу работу по поддержанию REPO проще!
Работа в аналогичном способе выпуска шаблонов, шаблоны запроса на тяга позволяют установить определенный шаблон для заполнения при создании запроса на тягу. Смотрите документы GitHub на УЗГ РУКОВОДСТВЕННЫМИ РУКОВОДНЫМИ РУКОВОДСТВАХ для того, как их создать.
Наличие шаблона запроса на тягу на месте — это способ убедиться, что вкладчик следит за рекомендациями, перечисленными в файле введения. В качестве грубого руководства вы можете использовать шаблон запроса на тягу, чтобы спросить вкладчик, чтобы подтвердить, что они завершили некоторые основные проверки. Например, вы можете задать подтверждение, что они прочитали соответствующие документы репо или для подтверждения их представленного кода следует рекомендации, перечисленные в файле вклада.
Ниже приведен пример шаблона запроса на тягу, используемый в одном из Inspirezone Github Repositories . Вы также можете бесплатно использовать этот шаблон, если вы хотите, скопировав файл pull_request_template.md из любого из наших repos в ваш.
Github этикетки Позвольте вам создавать категории для проблем и запросов по тяги. Применение этикеток позволяет проще пропустить сканирование и фильтрацию проблем и потянуть запросы, обеспечивая некоторую визуальную помощь.
Ярлыки являются важным инструментом, который вы должны использовать, чтобы сохранить свои проектные доски и потянутыми запросами. Они также очень просто использовать, так что нет оправдания, чтобы их не использовать!
Каждый REPO имеет раздел этикетки для просмотра и управления текущими метками. GitHub предоставляет набор меток по умолчанию, вы можете использовать, или если они не подходят, вы можете создавать новые метки.
Чтобы добавить этикетку на запрос на выпуск/потянуть, на правой панели запроса на выпуск/потянуть Нажмите «Ярлыки» и применить соответствующее. Вы также можете назначить более одного ярлыка на запрос на выпуск/потянуть.
Концепция этикеток проста в использовании и сохраняет проблемы и протягивает просьбу и легче поддерживать. Так что убедитесь, что вы их используете!
Github Docs описывает Действия GitHub Как способ автоматизировать, настроить и выполнить рабочий процесс разработки программного обеспечения.
Наличие действий GitHub в вашем репозитории является самым мощным способом для поддержания вкладов, поскольку его можно сделать автоматически. Если вы новый к нему, настроить действия GitHub правильно, вероятно, принимает наибольшую работу из всех предметов на этом контрольном списке. Однако эта сторона технического обслуживания репо не должна игнорироваться!
Это хорошая идея, чтобы познакомиться с действиями GitHub и как они работают с вашим рабочим процессом, чтение через Официальная документация GitHUB по этой теме.
Как основное введение, действия GitHub позволяют выполнять задачи в вашем хранилище на основе определенных событий. Каждое событие вызывает рабочий процесс, который является набором инструкций и заданий для запуска. Github запускает рабочие процессы, найдя их в каталоге в вашем хранилище под названием .Гитеб/рабочие процессы/ . Файлы рабочего процесса используют Ямл Структура синтаксиса.
Действия GitHub очень мощные, потому что если при правильном настроении вы можете избежать ручных проверок каждого обновления, сделанного в ваш репозиторий. Вы также можете выполнить действия на бегуны , которые являются виртуальными средами, выступающими в качестве сервера для вас для запуска кода. Это в основном GitHub, обеспечивая виртуальную машину в вашем распоряжении!
В качестве примера, давайте скажем, вы хотите, чтобы выбрать способ выполнения базового проверки кода проверяет, когда кто-то подает запрос на потяжку вашего репо. Вы хотите сделать 2 вещи, когда отправлен запрос на тягу:
- Проверьте ответ
- Проверьте, код будет выполнен без ошибок
Это может быть сделано с действиями GitHub, имея действие, которое будет вызвать на любой запрос на тягу. Когда кто-то подает запрос на потяну к вашему репозиторию, действие будет запущено и может использоваться для проведения льминальных проверок или для запуска кода в бегун виртуальной машины GitHub.
Теперь, когда кто-либо представляет запрос на тягу, код может быть автоматически проверен для этих вещей. Если какие-либо действия не удаются, вкладчик будет предупрежден в этом.
Пример результатов рабочего процесса действия GitHub для проверки отправленного запроса на тягу
Есть много способов начать работу с действиями GitHub либо путем создания собственных рабочих процессов или используя существующие рабочие процессы в качестве шаблона. Я настоятельно рекомендую вам просматривать Действие Github Marketplace который содержит множество шаблонов рабочих процессов, доступных для любого для использования. Просматривая существующие рабочие процессы, вы можете разработать идеи для автоматизированных задач и проверок, которые вы хотите запустить на своем собственном репо.
Если вы новичок в Действия GitHub, это примет работу, чтобы узнать, как их правильно использовать. Но время, потраченное на них, стоит того, сколько времени спасет вас в будущем благодаря возможности автоматизации!
Репозитории, которые я поддерживаю на Inspirezone Github Используйте действия с проверками льминантов, проверки выполнения кода и другие типы рабочих процессов, которые вы можете копировать и адаптировать к вашим собственным потребностям!
Это простой, но важный элемент для проверки вашего списка DO, прежде чем сделать репо живут.
Это включает в себя обновление описания вашего репо и добавления соответствующих тегов тематических тегов в REPO.
В разделе «О в разделе предоставит предварительный просмотр того, о чем ваш репо, когда люди сталкиваются с ним в результатах поиска. Раздел для добавления URL можно использовать для ссылки на ваш сайт или любой веб-сайт, относящийся к вашему репо. Теги темы позволяют всем искать эти теги, чтобы найти репо.
В разделе «Настройки репо» также обязательно установите и проверьте, все готово к работе. Ваше имя репо должно описать, что он делает как можно лучше. Также добавьте социальное изображение в настройках и убедитесь, что хранилище установлено на публичный Когда он готов к жизни.
Хотя это небольшие детали, важно упомянуть об этом, так как многие REPOS покинут дополнительные поля пустыми. Поэтому убедитесь, что вы заполните их, чтобы люди могли знать, о чем ваша репо и фактически найдет его от поисковых фильтров!
Поддержание репозитория с открытым исходным кодом не является легкой задачей. Требуется некоторое планирование и способность устанавливать правила, которые могут легко следовать, чтобы гарантировать, что REPO хранится аккуратно и поддерживаемым.
Важно, у вас есть базовые элементы для любого вида открытого исходного кода, который вы хотите сохранить. В противном случае, это может стать трудно поддерживать как масштабы проекта И у вас есть больше участников.
Работа по техническому обслуживанию должна быть проще, имея контрольный список этих элементов и проверять каждый выкл, прежде чем сделать публику вашей репозитории.
Вы поддерживаете репозитории с открытым исходным кодом? Поделитесь ими в комментариях ниже. Также предлагайте некоторые из ваших собственных советов по поддержанию их!
Если вы нашли, что это полезно проверим больше сообщений о наконечниках разработчиков и продуктивности кодирования на мой блог 🙂
Открытый исходный код, способствующий (2 части серии)
Оригинал: «https://dev.to/funbeedev/the-essential-checklist-for-every-open-source-repository-maintainer-16en»