valtersit/wordpress-cve-scannerСканируйте ядро WordPress, темы и плагины на известные CVE из командной строки. Открытый исходный код, возможность аудита, приоритет приватности — на базе ValtersIT CVE API.
Чтобы вам было проще начать работу с GitLab, вот список рекомендуемых дальнейших шагов.
Уже профессионал? Просто отредактируйте этот README.md и сделайте его своим. Хотите упростить себе задачу? Используйте шаблон внизу!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/wordpress-cve-scanner.git
git branch -M main
git push -uf origin main
Используйте встроенную непрерывную интеграцию в GitLab.
Когда вы будете готовы сделать этот README своим, просто отредактируйте этот файл и используйте удобный шаблон ниже (или структурируйте его как угодно — это всего лишь отправная точка!). Спасибо makeareadme.com за этот шаблон.
Каждый проект уникален, поэтому подумайте, какие из этих разделов применимы к вашему. Разделы, использованные в шаблоне, — это рекомендации для большинства проектов с открытым исходным кодом. Также помните: хотя README может быть слишком длинным и подробным, слишком длинный лучше, чем слишком короткий. Если вы считаете, что ваш README слишком длинный, подумайте об использовании другой формы документации вместо сокращения информации.
Выберите самообъясняющее название для вашего проекта.
Дайте людям понять, что именно умеет ваш проект. Предоставьте контекст и добавьте ссылку на любые справочные материалы, с которыми посетители могут быть не знакомы. Здесь также можно добавить список возможностей или подраздел «Предыстория». Если у вашего проекта есть альтернативы, это хорошее место, чтобы перечислить отличительные факторы.
В некоторых README вы можете увидеть небольшие изображения, передающие метаданные, например, проходят ли все тесты для проекта. Вы можете использовать Shields, чтобы добавить некоторые из них в свой README. У многих сервисов также есть инструкции по добавлению значка.
В зависимости от того, что вы создаёте, может быть хорошей идеей включить скриншоты или даже видео (вы часто будете видеть GIF-файлы вместо настоящих видео). Такие инструменты, как ttygif, могут помочь, но обратите внимание на Asciinema для более изощрённого метода.
В рамках конкретной экосистемы может существовать общепринятый способ установки, например, с помощью Yarn, NuGet или Homebrew. Однако учтите, что тот, кто читает ваш README, может быть новичком и хотел бы получить больше указаний. Перечисление конкретных шагов помогает устранить неоднозначность и позволяет людям как можно быстрее начать использовать ваш проект. Если он работает только в определённом контексте, например, с определённой версией языка программирования или операционной системы, или имеет зависимости, которые нужно устанавливать вручную, также добавьте подраздел «Требования».
Щедро используйте примеры и, если можете, показывайте ожидаемый результат. Полезно иметь встроенный самый маленький пример использования, который вы можете продемонстрировать, при этом предоставляя ссылки на более сложные примеры, если они слишком длинные, чтобы разумно включить их в README.
Расскажите людям, куда они могут обратиться за помощью. Это может быть любая комбинация трекера задач, чата, адреса электронной почты и т. д.
Если у вас есть идеи для будущих релизов, хорошей идеей будет перечислить их в README.
Укажите, открыты ли вы для вкладов и каковы ваши требования для их принятия.
Для людей, которые хотят внести изменения в ваш проект, полезно иметь некоторую документацию о том, как начать. Возможно, есть скрипт, который им следует запустить, или некоторые переменные окружения, которые им нужно установить. Сделайте эти шаги явными. Эти инструкции также могут быть полезны вам в будущем.
Вы также можете документировать команды для линтинга кода или запуска тестов. Эти шаги помогают обеспечить высокое качество кода и снизить вероятность того, что изменения случайно что-то сломают. Наличие инструкций для запуска тестов особенно полезно, если требуется внешняя настройка, например, запуск сервера Selenium для тестирования в браузере.
Выразите признательность тем, кто внёс вклад в проект.
Для проектов с открытым исходным кодом укажите, как они лицензированы.
Если у вас закончились силы или время для вашего проекта, поставьте пометку в верхней части README, сообщающую, что разработка замедлилась или полностью остановилась. Кто-то может решить форкнуть ваш проект или вызваться в качестве мейнтейнера или владельца, что позволит вашему проекту продолжать существование. Вы также можете явно запросить мейнтейнеров.