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 の上部に開発が減速したか完全に停止したことを記した注記を入れてください。誰かがあなたのプロジェクトをフォークしたり、メンテナーやオーナーとしてボランティアで引き継ぐことを選ぶかもしれません。それによりプロジェクトを継続できます。メンテナーを明示的に募集することもできます。