📝Docs: README 실험 결과 설명 수정

[mmije0ng]

#️⃣연관된 이슈

• ♻️ Refactor: k6 도입 후 부하테스트 진행 #14

📝작업 내용

README 실험 결과 설명 수정

README 실험 결과 설명 수정

핵심 변경 사항

성능(Performance)

• 부하 테스트 문서화 강화: 제목을 “부하 테스트 및 성능 최적화”로 변경하고 k6 부하 테스트(예: 1 → 1,000 VUs) 범위 및 Prometheus/Grafana 모니터링을 명시.
• 인프라 컨텍스트 추가: AWS, Docker 기반 환경과 테스트 대상(백엔드/WAS/DB/Redis) 범위를 설명해 성능 재현성과 결과 해석 신뢰성 향상.
• 버전별 성능 비교 및 시각화 보강: v1~v4 비교 메트릭과 실험 이미지 추가로 최적화 효과(쿼리 개선, WAS/DB 튜닝, Redis 캐싱 등)를 근거 중심으로 제시.

구조(Architecture & Docs)

• 문서 구조 재편: 기존 간결 보고서에서 환경, 대상, 메트릭 등 세부 섹션을 갖춘 체계적 실험 서술로 전환.
• 시각 자료 보강: 백엔드 아키텍처 다이어그램, ERD 및 여러 실험 이미지 추가로 구조/데이터 흐름 가시성 향상.
• Tech Stack 및 워크플로우 추가: 기술 배지(스프링, MySQL, Redis, Docker, k6 등)와 Git Flow/리포지토리 링크로 개발 프로세스와 의존성 명확화.

안정성(Reliability & Maintainability)

• 최적화 항목 명시: QueryDSL 쿼리 개선, WAS/DB 튜닝, Redis 캐싱 적용 등 변경 내용과 기대 효과를 문서화해 운영 안정성·확장성 고려사항을 제시.
• 향후 확장 노트 유지: Scale-out 및 ALB 등 수평 확장 전략을 언급해 확장성 검토 포인트 기록.

변경 범위 및 영향

• 파일: README.md
• 변경량: 약 +76 / -9 줄 (문서 중심 변경)
• 영향: 코드 변경 없음 — 문서 개선으로 실험 재현성, 성능 분석 근거, 아키텍처 이해도 및 온보딩 효율 개선.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md이 한국어 성능 보고서 형식에서 FarmON BackEnd 프로젝트 개요 중심 문서로 전환되었으며, 기술 스택, 아키텍처/ERD 시각화, 부하 테스트 및 성능 최적화(인프라·테스트 스펙 포함) 내용을 추가했습니다.

Changes

Cohort / File(s)	변경 사항
문서 재구성 및 브랜드 변경 README.md	기존 성능 보고서 헤더를 FarmON BackEnd 브랜딩으로 교체하고 전체 문서 구조를 프로젝트 개요 중심으로 재편
부하 테스트·성능 최적화 섹션 추가 README.md	섹션 제목을 “부하 테스트 및 성능 최적화”로 변경; 테스트 인프라(AWS, Docker), 테스트 스펙(k6 1,000 VUs), Prometheus/Grafana 모니터링 등 범위 및 환경 명시
실험·결과 서술 및 이미지 확장 README.md	실험 설명 포맷 수정(시나리오 표기법 업데이트), 여러 실험 섹션에 이미지/시각자료 추가, v1~v4 성능 비교 표 및 메트릭 형식 확장
최적화 변경사항 정리 (쿼리/튜닝/캐시) README.md	기존 “무엇이 변경되었나?” 문구 제거 및 간결한 제목으로 재작성; QueryDSL 최적화, WAS/DB 튜닝, Redis 캐싱 적용 내용 유지
기술 스택·아키텍처·레퍼런스 추가 README.md	Tech Stack 배지 및 목록 추가(Spring Boot, Java, JWT, MySQL, Redis, STOMP, RabbitMQ, Docker, Nginx, AWS, GitHub Actions, Swagger, k6, Prometheus, Grafana), Backend 아키텍처·ERD 이미지 및 git flow/조직 저장소 링크 추가
메타데이터·마감 문구 보존 README.md	문서 말미의 향후 확장(Scale-out, ALB) 언급 및 기타 메타데이터(실험 범위·타겟·메트릭) 보강

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 README에 깃털 모아쌓고,
새로 쓴 문단에 당근을 꽂네.
스택 배지 반짝, 그림도 춤추고,
부하 테스트 소리 높이 울려라—
농장엔 봄이 오고 있어요! 🌾✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	제목은 README 문서의 실험 결과 설명을 수정하는 변경사항을 정확히 요약하며, 주요 변경 내용을 명확하게 전달합니다.
Description check	✅ Passed	PR 설명은 필수 섹션(연관된 이슈, 작업 내용)을 모두 포함하고 있으며 관련 이슈 #14를 명확히 참조하고 있습니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f397bd and 0545f3c.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

8-8: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

8-8: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

16-16: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

59-59: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

85-85: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

103-103: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

142-142: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

142-142: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

144-144: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

145-145: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

146-146: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

147-147: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

148-148: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

149-149: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

150-150: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

155-155: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

156-156: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

157-157: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

158-158: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

159-159: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

160-160: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

164-164: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

165-165: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

166-166: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

170-170: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

170-170: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

174-174: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

174-174: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

178-178: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

178-178: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

189-189: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

189-189: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

190-190: Bare URL used

(MD034, no-bare-urls)

---

190-190: Files should end with a single newline character

(MD047, single-trailing-newline)

🔇 Additional comments (4)

README.md (4)

1-5: 프로젝트 소개가 명확하고 잘 작성되었습니다.

프로젝트의 목적과 범위가 효과적으로 전달되고 있으며, 한국어 표현도 자연스럽습니다.

---

8-138: 성능 최적화 과정이 체계적으로 문서화되었습니다.

단계별 개선 사항(N+1 제거 → 인프라 튜닝 → Redis 캐싱)과 성능 지표 비교가 명확하게 정리되어 있어, 최적화 과정을 이해하기 쉽습니다. 특히 각 구간별 성능 변화 분석과 병목 지점 식별이 유용합니다.

---

170-176: 아키텍처 및 ERD 다이어그램이 잘 추가되었습니다.

시각적 자료와 함께 대체 텍스트도 적절히 포함되어 있어 접근성이 확보되었습니다.

---

178-187: Git flow 설명이 명확합니다.

브랜치 전략과 각 브랜치의 역할이 잘 정리되어 있습니다.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@README.md`:
- Line 188: Replace the bare URL "https://github.com/Farm-On/BE" in README.md
with a Markdown link (e.g. [Farm-On BE](https://github.com/Farm-On/BE)) so it
renders properly, and ensure the file ends with a newline character by adding a
trailing line break at EOF.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 006bbaa and 6f397bd.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

7-7: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

7-7: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

8-8: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

15-15: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

58-58: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

84-84: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

102-102: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

140-140: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

142-142: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

143-143: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

144-144: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

145-145: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

146-146: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

147-147: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

148-148: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

153-153: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

154-154: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

155-155: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

156-156: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

157-157: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

158-158: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

162-162: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

163-163: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

164-164: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

168-168: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

168-168: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

172-172: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

172-172: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

176-176: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

176-176: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

187-187: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

187-187: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

188-188: Bare URL used

(MD034, no-bare-urls)

---

188-188: Files should end with a single newline character

(MD047, single-trailing-newline)

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

배지 이미지에 대체 텍스트(alt text) 추가 필요

기술 스택 배지 이미지들에 대체 텍스트가 누락되어 있어 접근성(accessibility) 문제가 발생합니다. 스크린 리더 사용자들이 어떤 기술이 사용되었는지 파악할 수 없습니다.

각 배지에 해당 기술명을 alt text로 추가해주세요.

♿ 접근성 개선을 위한 수정 제안

-  <img src="https://img.shields.io/badge/SpringBoot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white">
-  <img src="https://img.shields.io/badge/Java-007396?style=for-the-badge&logo=openjdk&logoColor=white">
-    <img src="https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=jsonwebtokens&logoColor=white">
+  <img src="https://img.shields.io/badge/SpringBoot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white" alt="SpringBoot">
+  <img src="https://img.shields.io/badge/Java-007396?style=for-the-badge&logo=openjdk&logoColor=white" alt="Java">
+  <img src="https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=jsonwebtokens&logoColor=white" alt="JWT">

나머지 배지들도 동일한 방식으로 alt 속성을 추가해주세요.

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

142-142: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

143-143: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

144-144: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

145-145: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

146-146: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

147-147: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

148-148: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

153-153: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

154-154: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

155-155: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

156-156: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

157-157: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

158-158: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

162-162: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

163-163: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

164-164: Images should have alternate text (alt text)

(MD045, no-alt-text)

[coderabbitai]

🧹 Nitpick | 🔵 Trivial

URL 링크 포맷팅 및 파일 끝 개행 추가

두 가지 마크다운 포맷 개선이 필요합니다:

1. Bare URL을 마크다운 링크 형식으로 변경
2. 파일 끝에 개행 문자 추가

📝 포맷팅 개선 제안

-https://github.com/Farm-On/BE
+[https://github.com/Farm-On/BE](https://github.com/Farm-On/BE)
+

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

188-188: Bare URL used

(MD034, no-bare-urls)

---

188-188: Files should end with a single newline character

(MD047, single-trailing-newline)

🤖 Prompt for AI Agents

In `@README.md` at line 188, Replace the bare URL "https://github.com/Farm-On/BE"
in README.md with a Markdown link (e.g. [Farm-On
BE](https://github.com/Farm-On/BE)) so it renders properly, and ensure the file
ends with a newline character by adding a trailing line break at EOF.