Проверка проектов с помощью статического анализатора и написание обзорных статей с найденными в них ошибками – задача не из лёгких. Почти всегда это работа не одного человека, а коллектива. Большую роль в этом процессе играет выбор проекта. От него напрямую зависит интерес читателей к той или иной статье. В этой заметке я хочу рассказать, как можно предложить интересный проект для анализа через GitHub.
Введение
PVS-Studio — это инструмент для выявления ошибок в исходном коде программ, написанных на языках С, C++ и C#.
В последние годы возможности анализатора и область его применения значительно выросли. Сейчас это мощный инструмент для повышения качества кода, доступный как для Windows, так и для Linux. В анализатор добавлены режимы работы, позволяющие легко запускать анализ независимо от используемой сборочной системы. Такой способ дает возможность без лишних усилий познакомиться с инструментом, а позже полноценно интегрировать себе анализатор для регулярного использования.
Так мы пользуемся анализатором, когда проверяем выбранные проекты для написания статей. На нашем сайте опубликованы статьи о проверке более, чем 270 проектов с открытым исходным кодом. Суммарное количество ошибок превысило значение в 10000. Все обзоры попадают в обновляемый список статей на сайте. Теперь предлагать проекты можно не только через форму обратной связи, но и GitHub.
Как предложить проект
В репозитории на GitHub мы разместили список проектов, в который будем заглядывать перед выбором темы для статьи. Пока список будет общий для C/C++ и C# проектов.
Любой желающий может добавлять интересный проект с открытым исходным кодом и присылать Pull Request.
Необходимая информация о проекте:
- Название проекта;
- Краткое описание на английском;
- Ссылка на официальный сайт (если есть);
- Ссылка на исходники (репозиторий или страница сайта с информацией, где скачать исходный код).
Важно. Нет смысла добавлять в список свои личные небольшие проекты. Для его проверки вы можете бесплатно воспользоваться анализатором и даже применять его регулярно (как использовать PVS-Studio бесплатно). Также не стоит добавлять уже проверенные проекты. Иногда мы их перепроверяем, но для этого обычно нужен особый повод. Незаконно утекшие в сеть исходники тоже не приветствуются.
Если вы являетесь разработчиком какого-нибудь проекта с открытым кодом, то возможно более интересное сотрудничество: совместная статья, обсуждение найденных ошибок и т.п.
Если хотите поделиться этой статьей с англоязычной аудиторией, то прошу использовать ссылку на перевод: Svyatoslav Razmyslov. Propose a project for analysis by PVS-Studio: now on GitHub
Автор: PVS-Studio