Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 3 additions & 85 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,4 @@
# 🍴 Awesome Food Spots

**Awesome Food Spots**는 코드잇 스프링 백엔드 스프린터가 알고 있는 맛집을 공유하는 오픈 소스 프로젝트입니다. 각자의 지역에서 추천하는 맛집 정보를 추가하고, 맛집 지도를 함께 만들어 보세요!


## 🚀 프로젝트 소개

이 프로젝트는 맛집 정보를 공유하는 동시에 GitHub의 Fork, Pull Request 과정을 학습할 수 있도록 설계되었습니다. 재미있게 즐기며 기여해 보세요!



## 📚 맛집 정보 형식

맛집 정보를 추가할 때 아래의 형식을 따라주세요. **Markdown** 파일을 사용하며, `data/` 디렉토리에 저장합니다.

### 파일 이름 규칙
- 지역명을 기준으로 저장합니다. 예: `data/서울_광진구.md`, `data/부산_해운대구.md`.

### 맛집 정보 예시
```markdown
### [맛집 이름]
- 📍 **위치:** 서울시 강남구 테헤란로 123
- 🍴 **메뉴 추천:** 김치찜, 된장찌개
- ⭐ **평점:** 4.5/5
- 💬 **코멘트:** 깔끔하고 맛있는 한식! 점심시간에 가면 줄 서야 할 수도 있어요.
```

## 🛠️ 참여 방법

아래 단계를 따라 맛집 정보를 추가하고 Pull Request를 보내보세요!

1. **프로젝트 Fork:**
- 이 저장소를 자신의 계정으로 포크(Fork)하세요.

2. **저장소 클론:**
- 로컬 환경에 저장소를 클론합니다.
```bash
git clone https://github.com/사용자명/awesome-food-spots.git
cd awesome-food-spots
```

3. **맛집 정보 추가:**
- `data/` 디렉토리에서 해당 지역 파일을 열고 맛집 정보를 추가하세요.
- 지역 파일이 없다면 새로 생성하세요.

4. **변경 사항 커밋:**
- 추가한 내용을 커밋합니다.
```bash
git add .
git commit -m "맛집 정보 추가 (지역명)"
```

5. **저장소로 푸시:**
- 변경 사항을 자신의 포크에 푸시합니다.
```bash
git push origin main
```

6. **Pull Request 보내기:**
- 원본 저장소로 이동해 Pull Request를 생성합니다.


## 🌟 기여 가이드

- 누구나 자유롭게 기여할 수 있습니다.
- PR 제목에 간단한 설명을 적어 주세요. 예: `맛집 정보 추가 (서울)`.
- 하나의 PR에는 **한 지역의 맛집 정보**만 추가해주세요.


## 💡 기여자 랭킹

맛집을 많이 추가해 주신 기여자는여기서 확인하세요! 🏆

- **1위:** 🥇
- **2위:** 🥈
- **3위:** 🥉


## 🎉 우리 프로젝트에 기여하는 첫 걸음!

이 프로젝트는 초보자와 오픈 소스 입문자를 위한 공간입니다. **Fork**, **Pull Request** 과정을 배우면서 맛집 정보도 공유하고, 즐겁게 협업을 경험해 보세요. ❤️


## 📬 문의

- 질문이나 아이디어가 있다면 [Issues](https://github.com/codeit-bootcamp-spring/awesome-food-spots/issues)를 활용해주세요!
- 📍 **위치:** 경기 고양시 일산동구 일산로316번길 5-6 1층
- 🍴 **메뉴 추천:** 오리지널마제소바
- ⭐ **평점:** 4.59/5