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

Swaggerのドキュメントタグ更新 #77

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

yuminn-k
Copy link
Member

@yuminn-k yuminn-k commented Mar 7, 2024

🔍 このPRで解決したい問題は何ですか?

  • Swaggerのドキュメント内のタグの表記を一貫性のあるものに更新することで、ドキュメントの可読性と整合性を向上させることを目指しています。具体的には、タグの命名をキャピタライズされた形式に統一することで、ドキュメントの明確性を改善します。

✨ このPRで主に変わったことは何ですか?

  • Swaggerのドキュメント内の全てのタグの表記をキャピタライズされた形式に変更しました。

🔖 主な変更点以外に追加で変更された部分はありますか?

  • なし

🙏🏻 Reviewerに特に見ていただきたい部分はありますか?

  • 変更されたタグの命名がプロジェクトの標準と一致しているかどうか、特に注意して確認していただきたいです。

🩺 このPRでテストや検証が必要な部分はありますか?

  • 特にテストコードの追加はありませんが、ドキュメントのレンダリングに影響がないか確認が必要です。

📚 関連するIssueやTrello、ドキュメント

🖥 作動する様子

Swagger

📌 PRを行う際の注意点

  • Reviewerはコードレビュー時に良いコードの方向性を示しますが、コード修正を強制することはありません。
  • Reviewerは良いコードを見つけた場合、賞賛と励ましを惜しみません。
  • レビューは特別なケースでない限り、Reviewerに指定された時点から3日以内に行ってください。
  • コメント作成時にPrefixにP1、P2、P3を書いていただくと、Assigneeがより明確にコメントに対して対応することができます。
    • P1 : 必ず反映してください (Request Changes) - 問題が発生したり、脆弱性が発見されたケースなど。
    • P2 : 反映を積極的に検討していただければと思います (コメント)。
    • P3 : こんな方法もあるんじゃないかな~などの些細な意見です (Chore)。

- Adjusted Swagger tags in 'docs.go' for improved categorization and clarity.
- This includes changes in tag naming from lowercase to capitalized versions for consistency.

Related issue: YJU-OKURA#9
@yuminn-k yuminn-k added ⏰ P3 추가적인 의견 제시나 소소한 개선사항 📃 Docs 문서 작성 및 수정 (README.md 등) 🆗 safe CI workflow 동작 관련 labels Mar 7, 2024
@yuminn-k yuminn-k merged commit 280f608 into YJU-OKURA:main Mar 7, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📃 Docs 문서 작성 및 수정 (README.md 등) ⏰ P3 추가적인 의견 제시나 소소한 개선사항 🆗 safe CI workflow 동작 관련
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants