Skip to content

docs: Documentation_Guide Docs패키지 파일에 추가 #5#6

Merged
jihun4452 merged 2 commits into
devfrom
docs/convention-guide-#5
Dec 20, 2025
Merged

docs: Documentation_Guide Docs패키지 파일에 추가 #5#6
jihun4452 merged 2 commits into
devfrom
docs/convention-guide-#5

Conversation

@jihun4452

Copy link
Copy Markdown
Contributor

Ⅰ. PR 내용 설명 (Describe what this PR did)
API 문서 작성 컨벤션 가이드(API_DOCS_EXAMPLE.md) 추가

Ⅱ. 관련 이슈 (Does this pull request fix one issue?)
fixes #5

Ⅲ. 검증 방법 (Describe how to verify it)

  • docs/API_DOCS_EXAMPLE.md 파일 확인
  • 마크다운 렌더링 정상 여부 확인

Ⅳ. 리뷰 시 참고 사항 (Special notes for reviews)

  • 이후 USER_API, MATCHING_API 등 도메인별 문서 작성 시 이 컨벤션을 따를 예정
  • 추가/수정이 필요한 항목 있으면 코멘트 부탁드립니다

* feat: sonarcloud 추가설정 및 yml추가 #2

* chore: sonarcloud.yml 워크플로우 브랜치 이름 변경 #2

* chore: sonarcloud 버전이 gradle 8버전과 맞지않아 변경 #2

* chore: Gradle 8.10으로 다운그레이드 #2
@jihun4452 jihun4452 self-assigned this Dec 20, 2025
@jihun4452 jihun4452 added docs 문서 수정 chore 자잘한 기능 수정 labels Dec 20, 2025
@sonarqubecloud

Copy link
Copy Markdown

@jihun4452 jihun4452 changed the title Docs/convention guide #5 docs: Documentation_Guide Docs패키지 파일에 추가 #5 Dec 20, 2025
@jihun4452 jihun4452 merged commit 4b00cbc into dev Dec 20, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore 자잘한 기능 수정 docs 문서 수정

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant