この記事内ではコードを書く上での決まりを書いていきます。
コードを書く時には、下記を守りながら書いていただければ幸いです。
綺麗なコードは単に自己満足だけでなく、メンテナンス性・可読性が向上します。
自分だけでなく、周りのためにも綺麗なコードを書きましょう!
Table of Contents
全体的なこと
以下の項目は必ず遵守して下さい
- 不安になったら速攻聞く
- あ、やばいかも、と思ったら速攻聞く
- え?これまずいんじゃ?と思ったら速攻聞く
- あ、これわかんね、どうすれば?と思ったら速攻聞く
- とにかく、すぐ聞く
- 塩田DMでも、チャンネルでもどちらでもOK
OS
プロジェクトでは、windowsとmac、どちらでも使用していただいて構いません。
どちらにも長所があるので、将来的にはどちらも使いこなせることがベターです。
さらに、共通する操作であるlinuxコマンドが使用することができれば、ベストです。
コード共有
Gitを使用してコードを共有します。
アカウントはgitHubで作成してください。
基本的な操作のみできれば十分です。
概念等はサルでもわかるGitを参照してください
使い方は共有いたします。
branch
ベースブランチはdevelopとします。
また、製品版はmaster、作業ブランチはfeatureとします。
featureブランチ
作り方
developブランチから
git checkout -b xxxxxx
で作成してコピーしてください。
命名方法
まず、BackLogにて着手するタスクを作成してください。
作成後に、左上にタスク番号が記載されます。
その記載されたタスク番号を feature/ の後ろにつけてください。
ex) feature/DMS-1
commit
コードをコミットする際は、以下を遵守してください
- コミットは作業単位ごとに、こまめに行う
- コミットメッセージは日本語で作業内容を簡潔に記載する
- コミット前に、コードをフォーマットする
- コミット前に、不要なconsole.logやコメントアウトがないか確認する
- コミットの前後に、git status を入力して抜け漏れがない確認をする
push
コードをpushする際は、以下を遵守してください
- タスクごとにpushをする
- 不要なコミットがないか、git log を入力して確認する
- git status を使用して漏れがないか確認をする
- git push origin featre/xxxx(自分のタスク) のコマンドでpushをする
プルリクエスト
プルリクエストを作成した際は、以下を遵守してください
- 反映するbase branch がdevelopになっていることを確認する
- メッセージ欄に、backlogの該当タスクのURLを貼り付ける
- メッセージ欄に、いい感じにユーモアが効いた面白いメッセージを書く
- メッセージ欄に、報告事項を記入する
- レビューリクエストに塩田を選択する
コードエディタ
コードを編集するときは、vscodeを使ってください。
今後はvscodeでの拡張機能を使う機会が増えるので、開発環境を揃えるためです。
開発環境が揃っていると効率が上がったり、一人だけエラーで詰まる、と言う事態がなくなります。
インデント
インデントは半角スペース2つで使用してください。
フォーマット
vscodeのフォーマッターはPritterを使用してください。
winでは
ctrl + alt + f
macでは
option + shift(⬆️) + f
でコードを整形して綺麗にすることができます。
HTML
今回はexpoを使用するため、通常のdivタグなど多くのものが使用できません。
代替えとして、viewタグなどを使用します。
そのため、かなり混乱するかと思います。遠慮せず聞いてください。
リファレンス を読んでいただければ幸いですが、読むことも難しいかと思います。
速攻聞いて下さい。
CSS
expoで動作させるため、いくつか使用できないクラスが存在します。
display: flex, width: calc() などは使うことができません。
今後、情報集約用のスプレッドシートを作成するので、現象と対処法・代替えをまとめていきましょう。
おわりに
細かく書きましたが、どんどん追記をしていきます。
こう言う細かいルールを体に染み込ませることで、汚いコードに蕁麻疹ができるようになります。
ぜひ遵守して、綺麗なコード、円滑なプロジェクト進行ができるように、
みんなで頑張って、楽しく進めていきましょう!!
0件のコメント