Canonical Webチームのベストプラクティスを説明するドキュメントのコレクション。
これらは、https://canonical-webteam.github.io/practices/でも表示できます。
このサイトは、Jekyllを使用して構築されています。
このサイトをローカルで実行するには、最初にローカルマシンにRubyをインストールする必要があります。
Rubyをインストールしたら、実行してBundlerをインストールできます。
gem install bundler -v 1.17.3
次のステップは、バンドラーを使用してサイトを実行するのに必要なRuby宝石をインストールすることです。
bundle install
その後、Jekyllを使用してサイトを提供できます。
jekyll serve
...ブラウザでhttp://127.0.0.1:4000/practices/でサイトをローカルに開く必要があります。
これらのドキュメントへの貢献に関するガイドラインについては、Convributing.mdを参照してください。
このコードベースでは、きれいなものを使用して、一貫したフォーマットを確保します。
コードベースできれいに実行するには(糸がインストールされていると仮定して)実行します。
yarn prettier-write **/*
インストールされた宝石を実行しようとするときに問題に遭遇した場合、それは見つからないと述べている場合は、宝石がインストールされているディレクトリがパスに含まれていることを確認してください。端末にecho $PATHを入力し、出力のフォルダーをチェックすることにより、これを確認できます。宝石がどのフォルダーに取り付けられているかわからない場合は、 gem env | grep EXECUTABLE DIRECTORYを実行します。 gem env | grep EXECUTABLE DIRECTORYと、パス環境変数に印刷されたパスを追加します。
このプロジェクトのコンテンツは、Creative Commons Attribution-Sharealike 4.0 Internationalライセンスの下でライセンスされており、そのコンテンツがCanonical LtdによってLGPLV3の下でライセンスされていることをフォーマットおよび表示するために使用される基礎コード。