Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: CONTRIBUTING.md 파일에 메서드 컨벤션을 작성합니다. #132

Merged
merged 7 commits into from
Jul 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,30 @@
### 2.2 Description

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

## 3. Convention

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

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

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

okinawaa marked this conversation as resolved.
Show resolved Hide resolved
함수명을 지을 때 아래와 같이 import될 것을 고려해야 합니다.

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

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