Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

99 lines (71 loc) · 3.57 KB
Raw

CONTRIBUTING

블로그 포스트를 작성할 사람

  1. 사전 설정

    1. 이 repository를 본인의 계정으로 fork해주세요! 저장소 우측 상단에 fork 버튼이 있습니다.

    2. fork한 repository를 본인의 컴퓨터로 clone하세요

    3. (선택) 포스트 작성을 위한 별도의 브랜치를 생성하세요

      ex) git checkout -b post/leemir

  2. 블로그 포스트 작성하기

    1. _posts 폴더에 포스트를 markdown형식으로 작성해주세요.

    2. 포스트 상단의 속성을 설정해주세요. (영어로 된 부분은 그대로 두고 한글 부분을 변경하시면 됩니다! 이해가 안가시면 다른 분들의 포스트를 참고해주세요.)

      • layout: post
      • title: 포스트 제목
      • authors: [작성자명]
      • tags: [태그1, 태그2, 태그3]
      • image: 포스트 커버 이미지
      • featured: true

    3. 포스트 작성 중, 이미지에 캡션 달기

      1. 다음과 같이 작성해주세요(띄어쓰기 주의)
          ![image](../assets/images/xxxx/xxxx)
    *캡션으로 달고 싶은 메시지*

    4. VS Code 확장(Ctrl+Shift+x)에서 markdownlint를 설치해 규칙에 맞게 작성했는지 확인해주세요.

  3. 원격 저장소로 push

    • 처음에 fork했던 본인의 원격 저장소로 push합니다. 별도의 설정을 안했다면 origin으로 되어있습니다.

      ex) git push origin [브랜치 이름]

  4. PR을 작성해주세요!

    • 이 레포지토리의 master 브랜치로 Pull Request를 날려주세요!
    • (주의) 상위 레포지토리인 wowthemesnet/mediumish-theme-jekyll 로 날리시면 큰일납니다.
    • PR이 블로그팀에 의해 merge되기 전까지는 브랜치를 따로 옮겨서 작업하지 않는 이상 push만 하면 알아서 현재 PR에 추가되니, 블로그팀이 수정 요청을 할 경우 수정 내용을 commit 후, push까지 해주시면 됩니다.

  5. 동기화해주세요!

    • fork한 지 오래됐다면 PR을 날릴 때 conflict가 일어날 가능성이 높습니다. 항상 포스트를 작성하기 전에는 pull 받아주세요!

      ex) git pull upstream master

(만약, git remote -v를 입력했는데 upstream이 없다면 아래 명령어를 입력해주세요)

git remote add -t master upstream https://github.com/GDSC-University-of-Seoul/gdsc-university-of-seoul.github.io.git

      ​

블로그 포스팅 수식 사용하는 방법

md파일 작성 시 use_math:true를 추가해주세요!

수식 참고 사이트

---
layout: post
title: 포스팅 제목
authors: [github 아이디]
tags: 
image: 
featured: true
use_math: true
---

블로그 author 추가하는 방법(블로그팀만)

  1. _data 폴더에 author.yml을 수정해주세요.

    1. author 속성은 다음과 같습니다.
        [닉네임]:
        name: [이름]
        display_name: [표시되는 이름]
        email: [본인 이메일]
        github: [Github 닉네임]
        role: [역할, lead || core || normal ]
        member: [현재 활동 여부 boolean]
        alumni: [alumni 여부 boolean]
        blog_team: [블로그 팀 테두리 입히기]
        web: [블로그 주소(선택)]