tech spoon 블로그 저자 등록 및 아티클 작성 가이드

이 가이드는 여러분이 tech-spoon의 컨트리뷰터가 되는 전체 과정을 안내합니다.

먼저 로컬 컴퓨터에 tech-spoon 프로젝트를 실행할 수 있도록 개발 환경을 설정하는 방법을 알아봅니다. 그다음, CLI를 활용해 자신만의 저자 프로필을 등록하고, 마지막으로 첫 아티클을 발행하기까지의 전체 기여 과정을 안내합니다.

컨트리뷰터 가이드

로컬에서 작업하기

tech-spoon 리포지토리 복제 (Clone)
의존성 설치

이 프로젝트는 의존성 및 워크스페이스 관리를 위해 yarn을 사용합니다.

최상위 경로에서 다음 명령어를 실행하여 의존성을 설치하세요.

yarn install

환경 변수 설정

로컬 개발 환경에서 tech-spoon을 실행하려면, Cloudinary 이미지 리소스를 사용할 수 있도록 환경 변수를 설정해야 합니다.

프로젝트의 최상위 경로에 .env.local 파일을 생성한 후, 해당 파일에 아래와 같이 Cloudinary 클라우드 이름을 지정하는 환경 변수를 추가합니다.

.env.local

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=dm5amo7c8

Git Flow 브랜치 전략

Tech Spoon 프로젝트는 Git Flow를 기반으로 브랜치를 관리합니다. 모든 작업은 main 브랜치가 아닌, 목적에 맞는 별도의 브랜치에서 진행해야 합니다.

저자 등록: author/{author_id} (예: author/john-doe)
아티클 작성: post/{article_slug} (예: post/tech-spoon-블로그-아티클-cli로-생성하기)

main 브랜치에 직접 변경사항을 커밋하지 않도록 주의해주세요.

Pull Request 제출

작업 브랜치에서 저자 등록 또는 아티클 작성을 완료하고 커밋까지 마쳤다면, 브랜치를 푸시하고 main 브랜치를 대상으로 Pull Request를 생성해주세요.

작성하신 내용이 리뷰어의 승인을 받으면, 이후의 배포 과정은 모두 자동화되어 있습니다. CI/CD 파이프라인이 변경사항을 즉시 프로덕션 환경에 반영하므로 별도의 배포 작업 없이 기여하신 내용을 확인하실 수 있습니다.

저자 등록하기

아티클을 작성하기 전에 먼저 tech-spoon에 저자로 등록해야 합니다. 터미널에서 아래 명령어를 실행하면, 스크립트가 필요한 정보를 단계별로 안내합니다.

yarn add-author

NOTE

작성자 이름: 블로그에 표시될 이름 또는 닉네임입니다.
작성자 ID: 저자를 구분하는 고유한 ID(예: john-doe)로, 아티클 작성 시 authors 필드에 사용됩니다.
아바타 이미지 ID (선택 사항): Cloudinary에 업로드한 프로필 이미지의 Public ID입니다.
Github ID (선택 사항): ID만 입력하면 https://github.com/{ID} 링크가 자동 생성됩니다.
LinkedIn 프로필 URL (선택 사항): 전체 프로필 URL을 입력해주세요. (예: https://www.linkedin.com/in/...)
직업 / 회사명 / 이메일 (선택 사항): 프로필 페이지에 표시될 정보입니다.

스크립트 실행을 마치면, 이 내용이 frontmatter에 담겨 아래와 같은 저자 프로필 파일(.mdx)로 생성됩니다.

data/authors/john_doe.mdx

---
name: 'John Doe'
id: 'john_doe'
avatar: 'anonymous_avatar'
occupation: '풀스택 개발자'
email: 'your.email@example.com'
github: 'https://github.com/your-github-id'
linkedin: 'https://www.linkedin.com/in/_your_username_'
---

간단한 소개를 Markdown 형식으로 작성해 보세요!

생성된 .mdx 파일의 본문에는 자유롭게 Markdown 또는 mdx 형식으로 소개글을 작성할 수 있습니다. 또한 새로운 저자 프로필 파일을 추가하면 자동으로 반영되며, 제 프로필 페이지와 같이 https://tech-spoon.me/about/{id} 경로에서 확인할 수 있습니다.

아티클 작성하기

터미널에서 아래 명어를 실행하면, 아티클 생성을 위한 스크립트가 필요한 정보를 단계별로 안내합니다.

yarn add-article

NOTE

아티클 제목: 블로그에 표시될 제목입니다.
작성자 ID: 저자를 구분하는 고유한 ID(예: john-doe)로, authors 필드에 사용됩니다.
요약문: 목록 페이지 및 SNS 공유 시 표시될 아티클 요약문입니다.
태그: 아티클과 관련된 키워드를 배열로 입력합니다. (예: ['guide', 'tech-spoon'])
대표 이미지 (선택 사항): Cloudinary에 업로드한 이미지의 Public ID를 입력하면 썸네일로 표시됩니다.
초안 여부 (Draft): true로 설정하면 배포 시 노출되지 않습니다.
작성일 / 수정일: 아티클의 작성일(date)과 최종 수정일(lastmod)을 기록합니다.
Canonical URL (선택 사항): 중복 콘텐츠 방지를 위해 원본 아티클의 URL을 입력합니다.

스크립트 실행을 마치면, 이 내용이 frontmatter에 담겨 아래와 같은 아티클 파일(.mdx)이 생성됩니다.

data/articles/tech-spoon-블로그-아티클-cli로-생성하기.mdx

---
title: 'Tech-Spoon 블로그 아티클 CLI로 생성하기'
authors: ['heesu', 'john_doe']
summary: 'CLI를 활용해 아티클을 빠르고 간편하게 생성하는 방법을 소개합니다.'
draft: false
date: '2025-08-27'
layout: 'PostSimple'
tags: ['guide', 'tech-spoon']
images: ['thumbnail_id']
lastmod: '2025-08-29'
canonicalUrl: 'https://www.tech-spoon.me/articles/tech-spoon-블로그-아티클-cli로-생성하기'
---

여기 아티클 본문을 작성하세요!

생성된 .mdx 파일의 본문에는 자유롭게 Markdown 또는 mdx 형식으로 아티클을 작성할 수 있습니다.

TIP

자세한 작성 방법은 tech-spoon 블로그 마크다운 가이드를 참고하세요.

새로운 아티클 파일을 추가하면 자동으로 반영되며, 해당 아티클과 같이 https://tech-spoon.me/articles/{slug} 경로에서 확인할 수 있습니다.

마무리

Tech Spoon에 여러분의 지식과 경험을 공유해주세요!
저는 개발자 여러분이 가장 익숙한 Git과 CLI 환경에서 편안하게 글을 작성하고 기여할 수 있는 워크플로를 제공하겠습니다.

추가로 더 궁금한 점이 있다면 언제든지 댓글로 문의해주세요!