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

Docs : Readme 게시물 상세 조회, 공유 내용 작성 #45

Merged
merged 5 commits into from
Nov 1, 2023

Conversation

refigo
Copy link
Contributor

@refigo refigo commented Oct 31, 2023

PR 체크리스트

아래 항목을 확인해 주세요:

  • 커밋 메시지가 우리의 가이드라인을 따르고 있는지 확인하세요
  • 변경 사항에 대한 테스트가 추가되었는지 확인하세요 (버그 수정 / 기능 추가)
  • 문서가 추가되거나 업데이트되었는지 확인하세요 (버그 수정 / 기능 추가)

PR 유형

이 PR은 어떤 종류의 변경을 가져오나요?

  • 버그 수정
  • 새로운 기능 추가
  • 코드 스타일 업데이트 (서식, 로컬 변수)
  • 리팩터링 (기능 변경 없음, API 변경 없음)
  • 빌드 관련 변경
  • CI 관련 변경
  • 문서 내용 변경
  • 애플리케이션 / 인프라 변경
  • 기타... 설명:

현재 동작은 무엇인가요?

이슈 번호: #44

새로운 동작은 무엇인가요?

  • 게시물 테이블 정보 작성
  • API 엔드포인트 작성
    • 게시물 상세 조회
    • 게시물 공유

이 PR은 호환성 변경을 도입하나요?

  • 아니요

기타 정보

명석님 PR 정보(#43)를 보니 기존 마무리와 배운점 항목이 사라져있어서 작성하지 않았습니다. (충돌 방지 겸 변경 수용)

@refigo refigo added the documentation Improvements or additions to documentation label Oct 31, 2023
@refigo refigo self-assigned this Oct 31, 2023
@refigo refigo changed the title Docs : Readme 게시물 통계 조회 관련 내용 추가 Docs : Readme 게시물 상세 조회, 공유 내용 추가 Oct 31, 2023
@refigo refigo changed the title Docs : Readme 게시물 상세 조회, 공유 내용 추가 Docs : Readme 게시물 상세 조회, 공유 내용 작성 Oct 31, 2023
Copy link
Member

@Zamoca42 Zamoca42 left a comment

Choose a reason for hiding this comment

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

고생하셨습니다!

Copy link
Contributor

@Sangun-Lee-6 Sangun-Lee-6 left a comment

Choose a reason for hiding this comment

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

고생하셨습니다!

마무리와 배운 점도 추가해주시면 좋을 것 같습니다.

Copy link
Contributor

@myeongseoklee myeongseoklee left a comment

Choose a reason for hiding this comment

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

LGTM!

README.md Outdated
Comment on lines 35 to 44
| content_id | string(UUID) | 이는 포스트가 속한 SNS에서 관리하는 고유 인식 값입니다. | |
| type | enum | 파일 객체의 유형입니다. 가능한 값은 "facebook", "twitter", "instagram", "threads" 입니다. | 'twitter' |
| title | string | 포스트 제목입니다. | 'hello, danishop!' |
| content | string | 이는 포스트의 내용이며 이미지, 비디오 등을 제외한 텍스트만 포함됩니다. | 'I visited the danishop' |
| hashtags | string[] | 여러 개의 해시태그가 있으므로 미래 검색을 고려하여 설계해 주십시오. | ['dani', 'danishop'] |
| view_count | number | 조회수입니다. | 100 |
| like_count | number | 좋아요 수입니다. | 10 |
| share_count | number | 공유 수입니다. | 1 |
| updated_at | Date | 포스트를 편집할 때 자동으로 기록됩니다. | |
| created_at | Date | 포스트를 생성할 때 자동으로 기록됩니다. | |
Copy link
Contributor

Choose a reason for hiding this comment

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

👁️ 카멜케이스로 변경되어야할 것 같습니다!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

수정 완료했습니다!

Copy link
Contributor

@hojoonSong hojoonSong left a comment

Choose a reason for hiding this comment

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

수고하셨습니다.

@refigo refigo linked an issue Oct 31, 2023 that may be closed by this pull request
4 tasks
@refigo refigo merged commit 1b0256f into main Nov 1, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

게시물 상세, 공유 README 작성
5 participants