zzugab/juice-shop-with-kubeadm-and-tfkubeadmとTerraformを使用したKubernetes上のOWASP Juice Shopの自動デプロイ、DevSecOpsパイプライン向けのTrivy脆弱性スキャン統合。
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 を読んでいる人が初心者であり、より多くのガイダンスを必要としている可能性を考慮してください。具体的な手順をリストアップすることで、あいまいさがなくなり、人々ができるだけ早くプロジェクトを使い始められるようになります。特定のプログラミング言語バージョンやオペレーティングシステムのような特定のコンテキストでのみ動作する場合、または手動でインストールする必要のある依存関係がある場合は、Requirements サブセクションも追加してください。
例を豊富に使用し、可能であれば期待される出力を示してください。インラインで示せる最小の使用例があると便利ですが、あまりにも長くて README に含めるのが現実的でない場合は、より高度な例へのリンクを提供してください。
ヘルプを得るためにどこに行けばよいかを人々に伝えてください。Issue トラッカー、チャットルーム、メールアドレスなどの任意の組み合わせで構いません。
将来のリリースのアイデアがある場合は、README にリストアップするのが良い方法です。
貢献を受け入れているかどうか、および受け入れるための要件を明記してください。
プロジェクトに変更を加えたい人のために、始めるためのドキュメントがあると役立ちます。実行する必要があるスクリプトや、設定する必要がある環境変数があるかもしれません。これらの手順を明示的にしてください。これらの指示は将来の自分自身にも役立つ可能性があります。
コードをリントしたりテストを実行したりするコマンドも文書化できます。これらの手順は、コードの高品質を確保し、変更が誤って何かを壊す可能性を減らすのに役立ちます。テストの実行手順は、ブラウザでのテスト用に Selenium サーバーを起動するなどの外部セットアップが必要な場合に特に役立ちます。
プロジェクトに貢献した人々への感謝の気持ちを示してください。
オープンソースプロジェクトの場合は、ライセンス方法を記載してください。
プロジェクトに費やすエネルギーや時間がなくなった場合は、README の上部に開発が遅くなったか完全に停止したことを記載するメモを追加してください。誰かがプロジェクトをフォークしたり、メンテナーやオーナーとして進んで引き継いでくれたりして、プロジェクトを継続させることができるかもしれません。また、メンテナーを明示的に募集することもできます。