cryptoadvocate/dcsgonefwbspCircuit Crafters初の電子バッジプロジェクトのファームウェアボードサポートパッケージホームです。
GitLab を使い始めるにあたり、推奨される次のステップのリストを以下に示します。
すでにプロですか？ このREADME.mdを編集して、自分だけのものにしてください。簡単にしたい場合は？ 下部のテンプレート を使用してください！
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.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に含めるには長すぎる場合は、それらへのリンクを提供してください。
人々がどこに助けを求めに行けばよいかを伝えてください。Issueトラッカー、チャットルーム、メールアドレスなどの任意の組み合わせにすることができます。
将来のリリースについてアイデアがある場合は、READMEにリストアップすると良いでしょう。
コントリビューションに対して開かれているかどうか、およびそれらを受け入れるための要件を述べてください。
プロジェクトに変更を加えたい人のために、開始方法に関するドキュメントがあると便利です。実行すべきスクリプトや設定すべき環境変数があるかもしれません。これらの手順を明確にしてください。これらの指示は将来の自分にも役立つ可能性があります。
また、コードをlintするコマンドやテストを実行するコマンドを文書化することもできます。これらの手順は、高いコード品質を確保し、変更が不意に何かを壊す可能性を減らすのに役立ちます。テストを実行するための手順は、ブラウザでテストするためにSeleniumサーバーを起動するなどの外部設定が必要な場合に特に役立ちます。
プロジェクトに貢献した人々に感謝の意を示してください。
オープンソースプロジェクトの場合は、ライセンスの内容を明記してください。
プロジェクトに対するエネルギーや時間が尽きた場合は、開発が鈍化または完全に停止したことをREADMEの上部に記載してください。誰かがあなたのプロジェクトをフォークしたり、メンテナーやオーナーとして名乗り出てプロジェクトを継続させるかもしれません。また、明示的にメンテナーを募集することもできます。