Skip to content

Instantly share code, notes, and snippets.

View HyoJeong1019's full-sized avatar
πŸ€—
Hello

HyoJeong HyoJeong1019

πŸ€—
Hello
View GitHub Profile
@HyoJeong1019
HyoJeong1019 / commit.md
Created June 12, 2021 16:04 — forked from abravalheri/commit.md
RFC: Git Commit Message Guidelines

Commit Message Guidelines

In the last few years, the number of programmers concerned about writing structured commit messages have dramatically grown. As exposed by Tim Pope in article readable commit messages are easy to follow when looking through the project history. Moreover the AngularJS contributing guides introduced conventions that can be used by automation tools to automatically generate useful documentation, or by developers during debugging process.

This document borrows some concepts, conventions and even text mainly from these two sources, extending them in order to provide a sensible guideline for writing commit messages.

@HyoJeong1019
HyoJeong1019 / how-to-write-by-markdown.md
Created May 29, 2021 10:35 — forked from ihoneymon/how-to-write-by-markdown.md
λ§ˆν¬λ‹€μš΄(Markdown) μ‚¬μš©λ²•

[곡톡] λ§ˆν¬λ‹€μš΄ markdown μž‘μ„±λ²•

1. λ§ˆν¬λ‹€μš΄μ— κ΄€ν•˜μ—¬

1.1. λ§ˆν¬λ‹€μš΄μ΄λž€?

Markdown은 ν…μŠ€νŠΈ 기반의 λ§ˆν¬μ—…μ–Έμ–΄λ‘œ 2004λ…„ 쑴그루버에 μ˜ν•΄ λ§Œλ“€μ–΄μ‘ŒμœΌλ©° μ‰½κ²Œ μ“°κ³  읽을 수 있으며 HTML둜 λ³€ν™˜μ΄ κ°€λŠ₯ν•˜λ‹€. νŠΉμˆ˜κΈ°ν˜Έμ™€ 문자λ₯Ό μ΄μš©ν•œ 맀우 κ°„λ‹¨ν•œ ꡬ쑰의 문법을 μ‚¬μš©ν•˜μ—¬ μ›Ήμ—μ„œλ„ 보닀 λΉ λ₯΄κ²Œ 컨텐츠λ₯Ό μž‘μ„±ν•˜κ³  보닀 μ§κ΄€μ μœΌλ‘œ 인식할 수 μžˆλ‹€. λ§ˆν¬λ‹€μš΄μ΄ 졜근 각광받기 μ‹œμž‘ν•œ μ΄μœ λŠ” κΉƒν—™(https://github.com) 덕뢄이닀. κΉƒν—™μ˜ μ €μž₯μ†ŒRepository에 κ΄€ν•œ 정보λ₯Ό κΈ°λ‘ν•˜λŠ” README.mdλŠ” 깃헙을 μ‚¬μš©ν•˜λŠ” μ‚¬λžŒμ΄λΌλ©΄ λˆ„κ΅¬λ‚˜ κ°€μž₯ λ¨Όμ € μ ‘ν•˜κ²Œ λ˜λŠ” λ§ˆν¬λ‹€μš΄ λ¬Έμ„œμ˜€λ‹€. λ§ˆν¬λ‹€μš΄μ„ ν†΅ν•΄μ„œ μ„€μΉ˜λ°©λ²•, μ†ŒμŠ€μ½”λ“œ μ„€λͺ…, 이슈 등을 κ°„λ‹¨ν•˜κ²Œ κΈ°λ‘ν•˜κ³  가독성을 높일 수 μžˆλ‹€λŠ” 강점이 λΆ€κ°λ˜λ©΄μ„œ 점점 μ—¬λŸ¬ 곳으둜 νΌμ Έκ°€κ²Œ λœλ‹€.

1.2. λ§ˆν¬λ‹€μš΄μ˜ μž₯-단점

1.2.1. μž₯점