es-hangul 라이브러리에 기여하기

커뮤니티의 모든 분들의 기여를 환영합니다.

모든 기여자는 우리의 행동 강령을 준수해야 합니다.
어떤 행동이 허용되고 허용되지 않는지 이해하려면 전문을 읽어주세요.

1. Issues

다음과 같은 방법으로 es-hangul 라이브러리에 기여할 수 있습니다:

• Improving our docs
• Reporting a bug in our issues tab
• Requesting a new feature or package
• Having a look at our issue list to see what's to be fixed

2. Pull Requests

Opening a pull request

자신의 PR을 제출할 수 있습니다. PR의 제목은 다음 형식과 일치해야 합니다:

<type>: <description>

우리는 당신의 이력에 있는 커밋의 수나 스타일을 중요시하지 않습니다, 왜냐하면 우리는 모든 PR을 main으로 squash merge하기 때문입니다.
편하게 커밋하세요.

2.1 Type

Type 은 아래의 것들 중 하나여야 합니다.

배포된 코드를 변경한 경우 :

• feat - 새로운 기능 추가에 대해
• fix - 새로운 기능을 추가하지 않는 수정에 대해

배포된 코드를 변경하지 않은 경우 :

• docs - 문서만 변경한 경우
• test - 테스트만 변경한 경우

그 외 :

• chore - 그 외 모든 것

2.2 Description

A clear and concise description of what the pr is about.

3. Convention

함수명에는 특별한 이유가 없다면 hangul을 포함하지 않습니다.

// Don't
function getHangulSimilarity();
// Do
function getSimilarity();

// Don't
function disassembleHangul();
// Do
function disassemble();

함수명을 지을 때 아래와 같이 import될 것을 고려해야 합니다.

import { getSimilarity, disassemble, josa } from 'es-hangul' // 따로 나눠서도 제공
import hangul from 'es-hangul' // hangul default export에 묶어서도 제공

hangul.getSimilarity(...)
hangul.disassemble(...)
hangul.josa(...)