1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/XmirrorSecurity-OpenSCA-cli

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING-zh_CN.md 12 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 14.03.2025 01:33 b475f4a

中文 | Русский

Гайдлайн для вклада (русская версия)

Гайдлайн для вклада в проект OpenSCA версия 1.0

Проект OpenSCA был запущен командой безопасности Xuanjing как открытый инструмент анализа состава программного обеспечения. В условиях быстрого развития и широкого использования открытых кодов и программного обеспечения, а также перед лицом все более серьезной проблемы безопасности цепочки поставок программного обеспечения, наша цель — использовать открытый подход для управления открытым риском. Приглашаем друзей стать частью сообщества OpenSCA, вместе с нами строить будущее проекта OpenSCA и исследовать бесконечные возможности открытых решений.

Мы ценим любую форму вклада, включая:

  • проверку существующего кода;
  • создание руководств и примеров развертывания;
  • участие в обсуждении сообщества через социальные каналы и раздел Issues;
  • реальные усилия по повышению функциональности проекта OpenSCA;
  • полезные советы по использованию, руководства и специализированному общению, способствующие долгосрочному развитию проекта.

Чтобы помочь вам эффективнее участвовать во всех аспектах вклада, мы подготовили этот гайдлайн для вклада, который будет регулярно обновляться в соответствии с развитием проекта. Этот гайдлайн включает следующие части:- правила поведения и системы вклада;

  • как представить ошибку;
  • типология ошибок;
  • вклад кода;
  • стандарты оформления кода.

Правила поведения и система вклада

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

Правила поведения

Сообщество OpenSCA заботится о каждом участнике; чтобы вместе создать положительную атмосферу в сообществе, просим вас прочитать наши правила поведения заранее и придерживаться их при участии.

Система вклада

Сообщество OpenSCA находится на начальной стадии развития и управляемо командой проекта OpenSCA Xuanjing. По мере развития сообщества мы радушно приветствуем и ожидаем новых участников, готовых сделать свой вклад и стать частью команды проекта, помогая нам поддерживать работу системы сообщества.Пока что временная система вклада делится на две части: код и баллы; кодовая часть, после того как вы отправите pull request (PR) с вашим кодом и он будет принят, вы станете Contributor'ом нашего проекта, имеющим возможность участвовать в дальнейшем планировании и реализации функций проекта, в установлении ошибок, проверке PR и сертификации Contributor'ов. Что касается баллов, помимо внесения кода, активное участие в сообществе за счёт отчета об ошибках, участия в технических обсуждениях и распространения опыта использования также может принести вам баллы. Накопленные баллы можно обменивать на призы регулярно. Подробные правила оценки баллов и получения наград могут меняться в зависимости от различных периодов деятельности. Для текущих подробных правил обратитесь к настройкам первой фазы плана "Seeding Plan".

Как сообщить о багеЕсли вы заметили ошибку при установке или использовании OpenSCA, вы можете сообщить о ней в разделе Issue; если же у вас есть вопросы относительно уже опубликованных нами документов, вы можете отправить письмо на адрес Opensca@anpro-tech.com, а также связаться с нами через официальный WeChat-аккаунт, группы WeChat или QQ.

Перед тем как сообщить об ошибке, убедитесь, что вы используете последнюю версию OpenSCA, просмотрите раздел Issue и проверьте, нет ли аналогичной проблемы от других пользователей. После выполнения этих шагов вы сможете сообщить о найденной проблеме в разделе Issue и ждать участия членов проекта или других участников сообщества в её обсуждении или решении; вы также можете создать Pull Request для исправления этой проблемы и затем ждать его одобрения со стороны членов проекта.

Проблемы безопасности не следует публично обсуждать. Если вы нашли уязвимость в OpenSCA, пожалуйста, отправьте информацию на адрес Opensca@anpro-tech.com для связи с нами.

Классификация ошибок

Разные типы ошибок влияют на использование OpenSCA по-разному. В соответствии с этим мы временно классифицируем ошибки следующим образом:

Основные ошибки: затрагивают основные функции (анализ компонентов на Java, PHP и т.д., распознавание уязвимостей).

Обычные ошибки: не влияют на функциональность, но могут влиять на удобство использования.Псевдо-баги: вызваны некорректной операцией или использованием старой версии

Основные баги требуют первоочередного решения, члены проекта будут активно работать над их устранением. Если у вас есть решение, вы можете предложить Pull Request, который будет рассмотрен членами проекта. Члены проекта будут корректировать некоторые части кода для решения обычных багов, а псевдо-баги будут своевременно рассматриваться, чтобы помочь вам найти возможные ошибки в вашей работе, чтобы вы могли лучше использовать OpenSCA.

Вклад в код

Проект OpenSCA нуждается в ваших вкладах для поддержания, совершенствования и расширения функциональности; основной формой вклада является создание Pull Request.

Вы можете предложить Pull Request для исправления багов или улучшения функциональности. Члены проекта будут проверять ваши Pull Requests. Чтобы повысить эффективность проверки, мы просим вас следовать кодовым стандартам проекта, каждый Pull Request должен быть направлен на решение одной конкретной задачи, и стремиться сделать ваш код более понятным, а также предоставить описание вашего вклада.

Если это Pull Request для исправления бага, то проверка будет сосредоточена на качестве кода;Если это Pull Request для улучшения функциональности, то проверка будет оценивать качество кода, новаторскую идею, реализацию функциональности и потенциал алгоритма. После того как члены проекта проверят ваш код и примут решение о его использовании, мы свяжемся с вами и пригласим подписать соглашение о пожертвовании (CLA), согласно которому вы передадите права на свой код проекту OpenSCA.После подписания соглашения ваш вклад в код станет частью проекта OpenSCA, а вы станете нашим CONTRIBUTORS'ом и сможете участвовать в дальнейшей работе над планированием и реализацией новых функций проекта, определением ошибок, проверкой PR и сертификацией CONTRIBUTORS'ов.


Мы благодарим каждого CONTRIBUTORS'а за его вклад в развитие OpenSCA.

Спасибо вам за внимание к нашему проекту и за понимание наших целей.

Англоязычную версию руководства по вкладу можно найти здесь: Contributing Guideline-en v.1.0.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/XmirrorSecurity-OpenSCA-cli.git
git@api.gitlife.ru:oschina-mirror/XmirrorSecurity-OpenSCA-cli.git
oschina-mirror
XmirrorSecurity-OpenSCA-cli
XmirrorSecurity-OpenSCA-cli
master