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

ガイドライン構造について #9

Open
Junko-Koide opened this issue May 8, 2024 · 1 comment
Open

ガイドライン構造について #9

Junko-Koide opened this issue May 8, 2024 · 1 comment
Assignees

Comments

@Junko-Koide
Copy link

ガイドラインの構造、現在すべて並列になっていますが、実際には以下のような感じかと思います。
調整可能でしょうか?

  • コーディングガイドライン
    • コーディングガイドラインについて(仮)
      • 🚩 概要
      • 🔧 ガイドラインの更新
    • 開発前の確認事項(仮)
      • 🔰 制作に取り掛かる前に
      • 🌐 対応ブラウザとデバイス
      • 🎯 プロジェクトのルールの最適化
      • 🌞 責任者の選任
      • 💻 制作環境
      • 📜 バージョン管理
      • 📄 テキストファイルに関する基本事項
      • ✅ 検証とテスト
      • 📛 識別子の命名規則
    • 📗 HTML ガイドライン
    • 📘 CSS ガイドライン
    • 💿 画像・メディアリソースガイドライン
    • 📙 JavaScript ガイドライン

また、 「📛 識別子の命名規則」は、案件によらない共通のルールとして置くのであれば、「検証とテスト」よりも前、あるいはドキュメントのもっと手前の位置でもよいように思いました。プロジェクトのルールの最適化など案件依存の条件に関する項目が前なので、具体的にどこに落とし込むかは難しいところですが…。

ご検討ください。

@Junko-Koide
Copy link
Author

Junko-Koide commented May 8, 2024

@YusukeHirao
「バージョン管理」の中にGitガイドライン(https://guidelines.d-zero.co.jp/git.html )が含まれていました。ほかガイドラインと同じように目次から見える場所(見つけやすい場所)に置いてよいのではと思います。
ほかガイドラインとは別に扱いたいという意図で、構造上「バージョン管理」の中に入れ込んでいるかもとも思いましたが、従うべき指針が見つけやすいことも重要かなと思いました。ご検討ください。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants