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

* Update CONTRIBUTING.md * fix * write contribution.md Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> --------- Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]>
toss · Jul 3, 2024 · 11e0ba9 · 11e0ba9
1 parent d58ba15
commit 11e0ba9
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -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();
+```
+
+함수명을 지을 때 아래와 같이 import될 것을 고려해야 합니다.
+
+```ts
+import { getSimilarity, disassemble, josa } from 'es-hangul' // 따로 나눠서도 제공
+import hangul from 'es-hangul' // hangul default export에 묶어서도 제공
+
+hangul.getSimilarity(...)
+hangul.disassemble(...)
+hangul.josa(...)
+