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-291] 🐛 ignoredPathsの更新:swagger URLの整理 #319

Merged
merged 1 commit into from
Jun 13, 2024

Conversation

yuminn-k
Copy link
Member

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

  • Swagger URLに関連する設定が冗長であるため、これを簡素化し、メンテナンスしやすくするための変更です。

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

  • ignoredPathsリストから重複するURLパターンを削除し、必要最小限のURLのみを残しました。

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

  • なし

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

  • 他に必要なSwagger URLパターンが見落とされていないか、確認をお願いします。

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

  • 特にありませんが、Swaggerの設定が正しく動作することを確認するテストを推奨します。

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

🖥 作動する様子

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

📌 PRを行う際の注意点

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

Reduced the list of ignored paths for swagger from four to two URLs to remove redundant patterns and simplify the configuration.

Related issue: YJU-OKURA#301
@yuminn-k yuminn-k added ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) ⚙ Setting 개발 환경 세팅 🐞 BugFix Something isn't working 🆗 safe CI workflow 동작 관련 labels Jun 13, 2024
main.go Show resolved Hide resolved
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 890a7ca into YJU-OKURA:main Jun 13, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐞 BugFix Something isn't working ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🆗 safe CI workflow 동작 관련 ⚙ Setting 개발 환경 세팅
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants