Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

コーディング規約についてのページを追加 #1449

Conversation

KentaHizume
Copy link
Contributor

@KentaHizume KentaHizume commented Oct 25, 2024

この Pull request で実施したこと

Marisのコーディング規約の階層と内容と揃うように、コーディング規約のページを追加しました。
該当ページの.NETアプリケーションに関する記述を、Javaアプリケーションに関する記述へと置き換えました。

この Pull request では実施していないこと

フロントエンド側については手を入れておりません。
TypeScriptの規約のリンク先となっているAirbnb JavaScript Style Guide()にについて、
正確にはAirbnb JavaScript Style GuideをTypeScript用にカスタマイズしたライブラリVue用にカスタマイズしたライブラリ
を使用している状態ですが、
この点についてはややこしくなることに加えて ES Lint 9 へのバージョンアップで大きく変わる可能性が高いため、修正しておりません。

package.json上で依存関係が見える、
Vue用にカスタマイズしたライブラリ
をリンク先にしておくほうが適切かもしれないとは考えており、
この点ご意見いただけると助かります。

Issues や Discussions 、関連する Web サイトなどへのリンク

Javaに関して記載すべき内容のコメント

@KentaHizume KentaHizume added ドキュメント改善 target: ガイド/AP開発手順 ドキュメントのガイド/アプリケーション開発手順に関係がある labels Oct 25, 2024
@KentaHizume KentaHizume added this to the v0.9.1 milestone Oct 25, 2024
@KentaHizume KentaHizume self-assigned this Oct 25, 2024
@KentaHizume KentaHizume linked an issue Oct 25, 2024 that may be closed by this pull request
@tsuna-can-se tsuna-can-se requested review from TakashiOhkubo and removed request for tsuna-can-se October 28, 2024 01:22
@tsuna-can-se tsuna-can-se added target: ガイド/規約 ドキュメントのガイド/規約に関係がある and removed ドキュメント改善 target: ガイド/AP開発手順 ドキュメントのガイド/アプリケーション開発手順に関係がある labels Oct 28, 2024

- Vue.js アプリケーション
- TypeScript

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Java側と比べると、リンクだけが記載されている状況なので、一言だけでも説明や特徴が書いてあるとバランスが良いかと思います

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TakashiOhkubo
ご指摘いただきありがとうございます。
Java アプリケーションとVue.jsアプリケーションで、
記載の粒度が揃うように段組みを変更のうえ追記いたしましたので、
再度ご確認お願いいたします。

Maris側のドキュメントへの反映は別途実施いたします。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: ガイド/規約 ドキュメントのガイド/規約に関係がある
Projects
None yet
Development

Successfully merging this pull request may close these issues.

コーディング規約について追記する
3 participants