su-its / ams-backend

:briefcase: (This repository is no longer maintained) The backend server of our Access-management-system.
MIT License
0 stars 0 forks source link

Lint #29

Closed h-takeyeah closed 3 years ago

h-takeyeah commented 3 years ago

単純な文法の修正です.変更は次の通りです.

特に「変数をキャメルケースにした」で変更されたacceptGuest(config.ts.sample内)という変数はams-projectリポジトリで言及されているメンバーを導入するなら使う変数であり現状の動作には特に影響がありません.

h-takeyeah commented 3 years ago

コンフリクトがあったので解消しました

ghost commented 3 years ago

@h-takeyeah えっと...たぶんなんですけど、命名規則がこの二つだけなら足らないし、 前に指摘したことが記載漏れになっています。

まあ人間ですので誰しも忘れることは当然あるのですが、例えば「JSON」および「API」部はスネーク法にならざるを得ないことが書かれていないので、フロント開発時に問題になると思います。

後は、jsdocを前提にしたコメントの書き方も前向きに検討してほしいです。

もっと細かいことをいえば、関数名、変数名はどう決めるのか、tmp使っていいのか等考慮するべきことは山のようにあると思います。

今回は若干当たって砕けろみたいな感じになると思いますが、今後の学習に活かしてほしいです。

h-takeyeah commented 3 years ago

@Stroheim001 レビューありがとうございます.

えっと...たぶんなんですけど、命名規則がこの二つだけなら足らないし、 前に指摘したことが記載漏れになっています。

あとから言われたことも柔軟に取り込めや!って話なんですけど,このPRの当初の目的としてはアロー関数を普通のfunction hoge()の形に書き直すことと,スネークケースの変数をキャメルケースで書き直すことでした.ですからこれで十分だと考えてPRを出したところです.

スネークケースがJSON部,API部に入り込むのは避けられないということを明記しなかったのは自分の落ち度です.すみませんでした.

関数にはどんな意味があるのか簡単に記載してもらえると嬉しいです。

これは了解しました.やります.


その辺を含んだコミットを作ろうかと思うのですが,上記の内容をどこに記載したらよいでしょうか? それから「前に指摘したこと」が何だったか失念してしまったのでもう一度教えていただけないでしょうか?このPRに書いたよ~などの情報がいただけると嬉しいです.

h-takeyeah commented 3 years ago

とりあえず前述の2点を修正するためにこのブランチを切りましたが,命名規則の検討やJSDocの書き方練習に使うブランチにしてしまうのもありかもですね.

ghost commented 3 years ago

@h-takeyeah CONTRIBUTE.mdに記載していても十分かと思います。あるいは、そこから辿れるリンクに記載しておく、というのもありだと思います。