-
基本はISSUE、PRベースでの開発フローにする（詳しくは後述）
-
ISSUEおよびPRはできるだけテンプレにしたがい、Viewを作成した際はスクショを貼り付けたい。
-
開発する際
// 初めてときもしくは新たにパッケージを更新などしたとき npm install
$ npm start
// これでTypescript,Scss共にコンパイルされる- イシュー作るタイミング
- 新規機能提案
- Bug報告
- 何か質問などあれば
TODO
https://tech.gamewith.co.jp/entry/2018/05/22/154951
ISSUEタイトル -> Bug：〇〇が正常に機能していない
内容は 何をしたいのか。どうしてしたいのか。それしてどうなるのか。この三つを記載すること。
-
基本的にPRApproveされることをマージ条件とする。
- 同学年でも疑問におもったらすぐ聞こう。
-
PRを出すとき、作業に入るときに注意したいこと。
BranchNameは
${ISSUE_Number}/${作業内容}のようにすること。 (like : 149/bug_fix_message_send_func)ISSUE番号のあとにprefixとして以下を採用するとわかりやすくなる気がする。
feat: A new feature fix: A bug fix docs: Documentation only changes style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) refactor: A code change that neither fixes a bug nor adds a feature perf: A code change that improves performance test: Adding missing or correcting existing tests chore: Changes to the build process or auxiliary tools and libraries such as documentation generation -
PRのdescriptionには
- ISSUE番号
- なにを実装したのか
- どう実装したのか
- 現状の問題点（特に確認して）もらいたいこと などを記載したい。
FIXME: 雑に書きすぎてしまった。
- Componentとなる粒度の物を配置する。 ここでいうコンンポーネントは二画面以上で使い回す or 一画面でしか利用しないがJSXの可読性を上げるために分割した粒度を分割する基準の一つとする。 ただし↑のルールにとらわれず、Atomicデザインレベルでの分割をしても基本的には動けばおk。
- 基本的に１コンポーネント1 styleで管理したい。
src/typescripts/components/に新規のComponetファイル(${sample}.tsx)を作成したら
export class Sample extends React.Component<{}, {}> { }のようにファイル名をCamelCaseにしたクラス名にて作成する
その後 src/typescripts/components/index.tsというファイルにて
export * from './sample';
のようにexportするように宣言をする
フロントエンドでの型定義のような物
このEntitiesのインスタンスとしてフロント側で管理することでAPIからうけとったJsonをオブジェクトのように扱えるようにしている。
Viewファイルから直接触ることはすくなく、factory層にてApiレスポンスを受け取った時の初期化に利用する
新規にあつかうプロパティを追加する時はここのコンストラクタに追加し、それぞれ`new Class`としている箇所のプロパティを変更してやれば良い。
APIレスポンス（JSON）を受け取りフロントエンドでのインスタンスに作り直すクラス。
受け取った値の加工などがあれば簡易な物ならここでやってしまっても良いかも。
entitiesのコンストラクタを使ってインスタンスを返却する。
`***.createFromJSON(ApiRes)`とすることで呼び出すことが可能なのでAPIのレスポンスを受け取った後によび出して上げる。
汎用性の高いクラスを置く場所、現状はApiClientを管理している
それぞれの画面を表示している箇所。
新規ページをつくるさいは基本的にはここを編集して新規の物を作成する。
Viewにおきたくないような処理をおく。
***Service.***として呼び出すことが多そう。
最後になってしまったが、基本的に新規のファイルを作成したらそのDirにあるindex.tsにて exportすることが必須。
'scss'の場合はapplication.scss での import宣言 なのでうまく動かない場合はそこらへんを疑うといいかも