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.

Sign up for GitHub

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
+27 −0
Merged

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

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e08c928
Update CONTRIBUTING.md
okinawaa Jun 25, 2024
5f563be
fix
okinawaa Jun 30, 2024
830e915
write contribution.md
okinawaa Jul 2, 2024
43c46c5
Merge branch 'main' into okinawaa-patch-3
okinawaa Jul 2, 2024
968ba68
Update .github/CONTRIBUTING.md
okinawaa Jul 3, 2024
f44d801
Update .github/CONTRIBUTING.md
okinawaa Jul 3, 2024
38dc523
Update .github/CONTRIBUTING.md
okinawaa Jul 3, 2024
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
18 changes: 18 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,21 @@
### 2.2 Description

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

## 3. Convention

es-hangul에서 외부로 노출하는 메서드들은 특별한 이유가 없다면 hangul을 생략합니다
okinawaa marked this conversation as resolved.
Show resolved Hide resolved

```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
- [결정된 논의를 자세히 살펴보기](https://github.com/toss/es-hangul/pull/132#discussion_r1660063497)
okinawaa marked this conversation as resolved.
Show resolved Hide resolved