Ross

1

Описание

Единый реестр программного обеспечения с открытым исходным кодом от российского .NET сообщества

Языки

  • PowerShell100%
README.md

RossDotNetRu

  • Статус: черновик
  • Все замечания принимаются в задаче №1

Единый реестр программного обеспечения с открытым исходным кодом от российского .NET сообщества (сокращённо также «реестр ПО с ОИК от DotNetRu») — публичная электронная система учёта программного обеспечения.

Аббревиатура RossDotNetRu происходит от англ. «the Registry of Open Source Software from the Russian .NET community».

Цели реестра

  • Популяризировать совместную разработку программного обеспечения с открытым исходным кодом среди русскоязычного населения
  • Поддерживать авторов репозиториев с открытым исходным кодом
  • Информировать сообщество об активных и полезных проектах с открытым исходным кодом

Правила формирования реестра

Решения о включении или об исключении из реестра принимаются на основании заключений экспертного совета представителей сообщества DotNetRu.

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

  1. Целевой проект развивается и распространяется по принципам не противоречащим открытому исходному коду
  2. Основным языком программирования должен быть язык на платформе .NET (C#, F#, PowerShell и т.д.)
  3. Основным языком общения и документирования репозитория должен быть русский
    • корневой README файл должен быть на русском языке
    • задачи (issues) в репозитории должны вестись на русском языке
    • документация внутри кода может быть на русском или английском языках
  4. Корневой README-файл должен содержать следующую информацию:
    • название проекта
    • кратное описание проекта
    • инструкцию по использованию проекта
    • инструкцию для помощи проекту
  5. Репозиторий должен быть активен:
    • автор отвечает на вопросы
    • задачи оперативно комментируются
    • критические уязвимости закрываются

Если репозиторий, включённый в реестр, престаёт соблюдать обязательные правила, он может быть исключён из реестра. Экспертный совет обязуется предупредить владельца через задачи репозитория о несоответствии. После чего, владельцу даётся 30 дней на устранение всех замечаний. Если за этот срок замечания не будут устранены в полном объёме, репозиторий удаляется из реестра.

Порядок подачи заявки на включение в реестр

Для подачи заявки на включение в реестр необходимо оформить запрос на слияние (merge request, pull request), содержащий краткое описание целевого проекта. Описание должно быть представлено в формате XML с кодировкой UTF-8 и включать в себя следующую информацию:

ИмяТипОписание
NamestringЧеловекочитаемое имя проекта
DescriptionstringЧеловекочитаемое краткое описание проекта, включающее его основное предназначение
RepositoryUriСсылка на репозиторий проекта. Поддерживаются: GitVerse, GitHub

Надо

  • Описать более строгую структуру README файла (конкретные заголовки и содержимое)
  • Описать требования к первым задачам для новичков (инструкцию, label, и т.д.)
  • Создать примеры XML файлов для записей реестра
  • Создать XML Scheme для записей реестра
  • Настроить автоматическую проверку записей реестра на соответствие схеме