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