zzugab/juice-shop-with-kubeadm-and-tfАвтоматизированное развертывание OWASP Juice Shop на Kubernetes с помощью kubeadm и Terraform, со встроенным сканированием уязвимостей Trivy для конвейеров DevSecOps.
Чтобы упростить начало работы с GitLab, вот список рекомендуемых следующих шагов.
Уже профессионал? Просто отредактируйте этот README.md и сделайте его своим. Хотите сделать это проще? Используйте шаблон внизу!
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.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.
Укажите, открыты ли вы для вклада и каковы ваши требования для его принятия.
Для людей, желающих внести изменения в ваш проект, полезно иметь некоторую документацию о том, как начать. Возможно, есть скрипт, который они должны запустить, или переменные окружения, которые нужно установить. Сделайте эти шаги явными. Эти инструкции также могут быть полезны вам в будущем.
Вы также можете задокументировать команды для проверки кода (lint) или запуска тестов. Эти шаги помогают обеспечить высокое качество кода и снижают вероятность того, что изменения случайно что-то сломают. Наличие инструкций по запуску тестов особенно полезно, если это требует внешней настройки, например, запуска сервера Selenium для тестирования в браузере.
Выразите свою признательность тем, кто внес вклад в проект.
Для проектов с открытым исходным кодом укажите, по какой лицензии он распространяется.
Если у вас закончились силы или время на проект, поместите примечание в начале README о том, что разработка замедлилась или полностью остановлена. Кто-то может решить форкнуть ваш проект или вызваться стать мейнтейнером или владельцем, чтобы проект продолжил жить. Вы также можете сделать явный запрос на мейнтейнеров.