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

[MIN-292] Swaggerのサマリーとパラメーターの説明を更新 #291

Merged
merged 1 commit into from
May 18, 2024

Conversation

yuminn-k
Copy link
Member

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

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

  • Swaggerのサマリーおよびパラメーターの説明、名前をコンベンションに従って修正。

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

  • なし

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

  • Swaggerドキュメントの変更が意図した通りに反映されているかどうかをご確認ください。

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

  • なし

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

🖥 作動する様子

スクリーンショットや録画したビデオ、またはgifを追加して、Reviewerが変更点を理解するのに役立ててください。

📌 PRを行う際の注意点

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

Modified summary, parameter descriptions, and names in Swagger to align with conventions.

Related issue: YJU-OKURA#9
@yuminn-k yuminn-k added ⏰ P3 추가적인 의견 제시나 소소한 개선사항 🔨 Refactor 코드 리팩토링 📃 Docs 문서 작성 및 수정 (README.md 등) 🆗 safe CI workflow 동작 관련 labels May 18, 2024
@github-actions github-actions bot requested review from Regulus0811 and Z00One May 18, 2024 05:02
Copy link
Collaborator

@Regulus0811 Regulus0811 left a comment

Choose a reason for hiding this comment

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

おつかれいっちー

@yuminn-k yuminn-k merged commit fee3569 into YJU-OKURA:main May 18, 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 추가적인 의견 제시나 소소한 개선사항 🔨 Refactor 코드 리팩토링 🆗 safe CI workflow 동작 관련
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants