blackcoffee-study / git-recipe

👨🏻‍🍳 전설의 레시피 👩🏻‍🍳

Git으로 관리하는 전설의 레시피 오픈소스

🔥 미션

여러분은 지금부터 전설의 레시피 오픈소스에 자신만의 레시피를 작성해서 기여해야합니다. 이 레시피는 오픈소스 이므로, Git 히스토리가 매우 엄격하게 관리되고 있습니다. 다음의 요구사항에 따라 여러분은 레시피를 개발하여 Pull Request를 보낼 수 있습니다.

미션 진행 방법

1. 저장소 fork

먼저 저장소를 fork한 후, fork된 저장소를 clone하여 레시피를 개발해주세요.

2. 레시피 개발할 브랜치 만들기

{나라이름}/{음식이름} 형식으로 레시피를 개발할 브랜치를 만들어주세요.

ex) korea/bibimbap

3. 레시피 개발할 마크다운 문서 만들기

recipes > {나라이름} > {음식이름}.md 형식으로 개발할 레시피 브랜치에서 작성할 마크다운 문서를 만들어주세요

ex) recipes > korea > bibimbap.md

4. 레시피 개발하기

[{음식이름}] {레시피 번호}. {레시피 내용} 형식으로 레시피를 자유롭게 개발해주세요. 단 이때 커밋 메시지는 아래와 같은 형식을 지켜주세요. 오픈소스이므로 커밋 로그가 일관되야 합니다.

ex) 커밋 메시지
[비빔밥] 1. 고슬고슬한 밥을 짓는다.
[비빔밥] 2. 콩나물을 무친다.
...

5. Pull Request 보내기

git-recipe 저장소에 Pull Request를 양식에 맞춰 보내주세요.

👏🏼 Contributing

안내 가이드 또는 레시피에 개선이 필요하다면 언제든 자유롭게 PR을 보내주세요.

🐞 Bug Report

버그 또는 문제를 발견한다면, Issues에 등록해주세요.

📝 License

This project is MIT licensed.