Analysis Rules for PT Application Inspector

В репозитории содержатся PM правила анализа для PT Application Inspector.

Содержание репозитория

В директории examples приведены примеры правил для анализатора на основе специального DSL и регулярных выражений (regex). Подробнее.

Пользовательские правила находятся в директории custom-rules.

Вносите свой вклад

Вы можете помочь нашему сообществу внеся вклад. Им могут быть:

1. PM правила для анализатора с использованием регулярных выражений (примеры и для реальных фреймворков);
2. PM правила для анализатора с использованием DSL (примеры и для реальных фреймворков);
3. Дополнения документации;
4. Упрощение существующих и добавление отсутствующих примеров;
5. Примеры кода для срабатывания правил.

Для этого:

1. Сделайте форк этого репозитория;
2. Внесите в нём необходимые изменения;
3. Откройте Pull Request. Для Regex правил добавьте ссылку на regex101.com или аналогичный сайт

Пользовательские правила должны быть размещены в директории custom-rules с описанием их предназначения. Важно не забыть обновить README. Важно размещать по одному правилу в файлах

Чеклист для внесения новых пользовательских правил

• Добавить JSON-файл с правилом в соответствующую директорию внутри custom-rules. Правило нужно добавить или в уже существующую поддиректорию или, если подходящей нет, создать новую
• При добавлении новой поддиректории: необходимо создать файл README.md с описанием новых правил
• При добавлении правил в уже существующую: необходимо обновить README.md в ней
• Необходимо обновить README.md. Описание правила можно продублировать из предыдущего пункта
• Для Regex правил добавьте ссылку на regex101.com или аналогичный сайт. Постарайтесь учесть все возможные случаи срабатывания и несрабатывания всех новых правил

Чеклист для внесения новых примеров

• Добавить новое правило в директорию с примерами
• При необходимости обновить README.md