📝 [Docs] Kernel360 Crew Blog 가이드라인

[anso33]

✨ 제출 방법

[공통]

• 파일 생성 시, 작성하시고자 하는 포스트의 카테고리와 일치하는 카테고리 구조 내의 _posts 폴더 내에 생성해 주세요.

[백엔드 개발 과정]

0. 기술블로그 초안 작성하기 (선택사항)
1. 브랜치 컨벤션에 맞게 생성하기
2. 생성한 브랜치에서 Git 마크다운 형식으로 테스트 글 작성하기
3. 테스트 글 Commit 하고 Main으로 PR 날리기
4. 셀원에게 PR 리뷰 신청하고 셀원들에게 Approve 받기
5. Main으로 Merge 하여 최종 기술블로그 업로드하기

[프론트엔드 개발 과정]

0. 기술블로그 초안 작성하기 (선택사항)
1. 브랜치 컨벤션에 맞게 생성하기
2. 생성한 브랜치에서 Git 마크다운 형식으로 테스트 글 작성하기
3. 테스트 글 Commit 하고 Main으로 PR 날리기
4. 크루 및 디렉터에게 PR 리뷰 신청하고 Approve 받기
5. Main으로 Merge 하여 최종 기술블로그 업로드하기

✅ Commit & Branch 생성 규칙

다음의 규칙을 따라서 Branch 생성 및 commit을 진행해주세요.

1️⃣ Commit

• 게시글 올릴 때
  • ex. feat: 20231106_가비지 콜렉션_박석희

2️⃣ Branch

main에서 발표날짜와 주제명을 기반으로 영어로 브랜치를 생성합니다.

• ex. 20231106/garbage-collection

✏️ 게시글 작성 규칙

다음의 규칙을 따라서 게시글을 작성해주세요.

1️⃣ 기술블로그 카테고리 작성 규칙

게시글의 유형에 맞는 카테고리를 선택해주세요. 카테고리 적용은 카테고리 명 폴더 안에 _post 폴더를 만든 후, 그 안에 포스트를 작성하는 방법으로도 적용이 가능합니다.

• "기술세미나"
  ex. 기술 세미나 발표 내용을 기반으로 작성한 게시글
• "프론트엔드 기술블로그"
  ex. 프로젝트를 하며 새롭게 배운 내용, 트러블 슈팅 등을 작성하여 공유하는 게시글
• "Kernel360 후기"
  ex. Kernel360에서 진행한 활동, 행사, 일상에 대한 후기
• "지식공유"
  ex. Kernel360 과정 내에서 진행한 프로젝트에서 알게된 지식들을 공유하는 게시글
• "자유 주제"
  ex. 운영진 소개, 주변 맛집 소개, 내가 만든 사이드프로젝트, 그룹스터디 후기, 은종 디렉터님 유튜브 출연

2️⃣ 기술블로그 게시글 작성방법

1. 백엔드의 경우, _posts 폴더에서 발표날짜-주제.md으로 파일을 생성해주세요.

2. 프론트엔드의 경우, _posts 폴더에서 제출날짜-주제-이름.md으로 파일을 생성해주세요.

   • ex. 2023-11-06-javaGC.md

3. md 파일 상단에 다음의 양식을 먼저 채워줍니다.
   이때 ` ` 으로 감싸진 항목만 수정해서 작성하시면 됩니다.

---
layout: post  
title: "게시글 제목"
author: "작성자 이름"
categories: "기술세미나"
banner:
  image: 썸네일로 넣고 싶은 이미지 링크
  background: "#000"
  height: "100vh"
  min_height: "38vh"
  heading_style: "font-size: 4.25em; font-weight: bold; text-decoration: underline"
  tags: [`게시글과`, `관련된`, `키워드를`, `다음과 같이`, `넣으시면`, `태그가`, `생성됩니다.`]
---

3. Git 마크다운을 사용하여 자유롭게 게시글을 작성합니다.

3️⃣ 기술블로그 이미지 파일 관리 규칙

1. 게시글 이미지 저장소 에 발표 날짜를 바탕으로 폴더를 생성한 후 해당 폴더에 이미지 파일을 저장합니다.

   • 폴더명 ex. 2023/1114

2. 이미지 파일 링크를 따서 게시글의 삽입하고자 하는 곳에 사용합니다.

💬 블로그 리뷰 방법

1. 오탈자, 마크다운 문법에 대해 틀린 부분이 없는지 확인하기
2. 게시글 내용에 잘못된 정보가 없는지 확인하기
3. 성의있는 리뷰를 통해 approve 부여하기

[fc-kernel360]

너무 잘써주셔서 감사합니다. 소현님 👍

[corazzon]

멋져요! 고생 많으셨어요 소현님 👍 💯
게시글 이미지 폴더 규칙을 변경했으면 해서 이슈로 남겨두었습니다. ( Kernel360/blog-image#3 )
감사합니다 :)