Docs : 깃헙 리드미 수정 #41
Docs : 깃헙 리드미 수정 #41
Conversation
myeongseoklee
requested review from
hojoonSong,
refigo,
Zamoca42 and
Sangun-Lee-6
| ### 📁 폴더 구조: | ||
| <br> | ||
|
|
||
| ## 🚀 프로젝트 소개 |
There was a problem hiding this comment.
프로젝트 소개 부분은 수정, 보완할 부분이 있다면 코멘트 남겨주세요
There was a problem hiding this comment.
핵심만 깔끔하게 요약해서 작성해주셨네요. 잘 작성해주셔서 감사해요~!
There was a problem hiding this comment.
유저 계정 해시태그 이외에 세부 검색 기능도 제공한다고 추가적으로 써도 좋을 것 같아요.
There was a problem hiding this comment.
유저 계정 해시태그 이외에 세부 검색 기능도 제공한다고 추가적으로 써도 좋을 것 같아요.
수정했습니다!
본 레포지토리는 유저 계정의 해시태그(”#user) 를 기반으로 `인스타그램`, `스레드`, `페이스북`, `트위터` 등 복수의 SNS에 게시된 게시물 중 유저의 해시태그가 포함된 게시물들을 하나의 서비스에서 확인할 수 있는 통합 Feed 어플리케이션의 Backend API 저장소입니다.
이를 통해 본 서비스의 고객(Client)은 유저계정(”#user”), 또는 브랜드(”#apple)등의 해시태그 검색으로 4개의 SNS에서 노출되고 있는 게시물과 통계를 한 번에 확인할 수 있습니다.
|
|
||
| ## 🛠️ Document 구조 | ||
|
|
||
| ### 1️⃣ 게시글(Article) |
There was a problem hiding this comment.
document 구조는 표로 합니다.
article을 예시로 넣어 두었으니 본인 도메인에서 쓴 필드를 입력해주세요.
각 필드에 대해 추가 설명이 필요하다면 표 하단에 '-'를 넣어 리스트로 넣어주세요.
ex) - contentId는 unique key
|
|
||
| <br> | ||
|
|
||
| ## 🌟 팀원 및 역할 소개 |
There was a problem hiding this comment.
일단 간략하게 역할을 제가 넣었습니다. 자신의 역할을 추가하거나 팀원이 이런 역할도 했다고 추가하고 싶으면 추가해주세요!
|
|
||
| ### 🎉 채용 공고 관리 | ||
| ## 📝 API 엔드포인트 상세 |
There was a problem hiding this comment.
여기서는 각자 자신이 개발한 엔드포인트에 대해 최대한 자세하게 작성하는 것이 좋습니다.
어떤 기능(whta)을 어떻게 구현했고(how) 왜(why) 그렇게 구현했는지 response 하단에 '-' 로 리스트로 기재해주세요!
| **Endpoint:** `GET /` | ||
| **Method:** `GET` | ||
| **Description:** Fetch a user using their email. | ||
| **Request Body:** `email` - The user's email. | ||
| **Response:** The email of the fetched user as a string. | ||
|
|
||
| --- | ||
|
|
||
| ## 🏁 마무리와 배운 점 |
There was a problem hiding this comment.
여기 부분 어떻게 좀 깔끔하게 정리할지 의견받습니다.
There was a problem hiding this comment.
프로젝트를 진행하면서 느꼈던 감정도 좋지만, 다음 사항도 들어가면 좋을 것 같습니다!
- 마주쳤던 문제나 고민
- (문제를 해결했다면) 해결 or (문제를 해결하지 못했다면) 해결 방안
|
틀을 잡아주시니까 너무 좋네요!! 감사합니다 |
PR 체크리스트
아래 항목을 확인해 주세요:
PR 유형
이 PR은 어떤 종류의 변경을 가져오나요?
현재 동작은 무엇인가요?
이슈 번호: #40
새로운 동작은 무엇인가요?
팀원들의 리드미 작성을 위해 내용과 디자인 틀 수정
이 PR은 호환성 변경을 도입하나요?
기타 정보