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

okinawaa · 2024-06-25T02:02:44Z

Overview

fix: #121

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

PR Checklist

I read and included theses actions below

I have read the Contributing Guide
I have written documents and tests, if needed.

vercel · 2024-06-25T02:02:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
es-hangul	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 3, 2024 3:08am

changeset-bot · 2024-06-25T02:02:47Z

⚠️ No Changeset found

Latest commit: 38dc523

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

manudeli · 2024-06-25T03:07:21Z

.github/CONTRIBUTING.md

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


이전에 동사형이면 좋겠다는 것은 알지만 hangul이 맥락을 넣는다면 아래와 같이 간결하게 표현하는 것은 어떨까요?

Suggested change

function getHangulSimilarity()

function similarityHangul()

similarityHangul 은 메서드로 보일지 의문이에요
아마 아래와 같이 사용될텐데 어색하지 않을까요 😢 ?

const hangulSimilarity = similarityHangul(x,y);

다른 주제이긴한데 Hangul의 위치가 맨 뒤로 고정되면 좋겠어요

getSimilarityHangul(text1, text2)

getHangulSimilarity가 영문법 해석상으로는 좀 더 매끄럽게 한글로 변환되기는 합니다.

getHangulSimilarity = get Hangul Similarity = 한글 유사성을 얻다

getSimilarityHangul = get Similarity Hangul = 유사성을 얻다 한글

2번, 즉 Hangul의 위치가 맨 뒤로 고정된다면 이름 변경 혹은 새로운 이름을 짓게 될 경우 매우 편할 거라는 생각이 들어요. 하지만 오픈소스 특성상 한국 국적외의 분들도 사용이 가능하니 이 점을 고려한다면 1번도 괜찮은 선택지라고 생각해요. 그래도 역시 한글이라는 특수성을 가진 라이브러리는 한국어를 어느정도 아시는 분들이 사용하실거라는 생각하여 2번을 추천해요.

이외에도 2번을 추천하는 이유는 코드 레벨에서의 작업 때문도 있는데요. 예를 들어, getHangulSimilarity와 getHangulAnything이 있다고 가정해볼게요. 추가로 대다수의 개발자분들이 import 자동완성 기능을 제공하는 IDE를 사용하고 있을거라고 가정할게요.

getHangul을 에디터에서 타이핑한 순간 IDE는 getHangulSimilarity, getHangulAnything 2개를 추천해주는 context를 보게 돼요. 아래의 예시들은 제 로컬 환경에서 관련 함수들을 만들어서 실험해봤어요.

context를 확인하면서 내가 정말 원하는 기능을 다시 찾아봐야 한다는 점이 불편해요. 지금은 단 2개 뿐이라서 길게 고민하지 않아도 돼요. 하지만 앞으로 더더욱 다양한 기능들이 생겨 Hangul이라는 명칭이 함수에 붙을 예정인 es-hangul을 생각한다면 그렇게 좋은 방향은 아닌 것 같아요.

물론 Hangul을 건너뛰고 getSi-로 타이핑하면 context가 나오기는 해요.

다만, 문제는 좀 더 길고 명확하게 타이핑하지 않으면 추천 context의 우선순위에서 밀린다는 점이에요.

반면에 Hangul을 맨 뒤로 보내볼게요. 보통 라이브러리에서 제공하는 네이밍을 그대로 따라치잖아요? getSi까지 타이핑을 해볼게요.

어떤가요? 앞에서 context를 바라보며 1~2초정도 고민을 했었다면 이번에는 단 1초의 고민도 하지 않고 엔터를 눌렀을 거라고 장담해요.

저는 실사용자의 입장에서 생각해봤는데요. 이러한 이유들로 @manudeli 님의 의견에 동의합니다.

이전에 동사형이면 좋겠다는 것은 알지만 hangul이 맥락을 넣는다면 아래와 같이 간결하게 표현하는 것은 어떨까요?

@manudeli get을 제거하고 similarityHangul이라고 명명하는 것은 "함수를 동사형으로 만든다"라는 일관성을 더는 지킬수가 없다고 생각해요. (참고)

'Hangul' 이라는 고유명사가 들어가는 경우에만 한정하여 일관성 규칙을 포기하려고 하시는 건지 궁금해요.

zod처럼 Fluent Interface 패턴과 Hangul이라는 단어가 생략된채로 제공하는 두 가지 방식 모두 같이 제공하면 좋다고 생각합니다. 개발자의 입맛에 맞게 사용할 수 있겠네요. 또는, lodash에서 사용하고 있는 방법인 "per method packages"방식으로 제공하는 것도 괜찮을 것 같습니다.

바로 위에서 @manudeli 님이 제안주신 컨벤션에 매우 동의합니다!
실제 예시를 보니, 더욱 직관적으로 이해할 수 있었습니다. 감사합니다!
7월1일까지, 다른 분들 추가 의견 없으면 @manudeli 님이 제안주신의견으로 진행하면 좋을 것 같아요

저도 완전히 동의하는 바입니다 !
그렇다면 #138 #130 등을 포함한 모든 메서드 네이밍에서 hangul을 제외하는 것으로 이해하면 될까요??

네네! 외부로 노출되는 메서드는 hangul을 제외하는 방향으로 진행하시죠! 다들 너무 감사합니다

#138 에서 hangul을 제외하는 작업도 같이 진행해도 괜찮을까요??
PR의 이름, 목적과 잘 부합하는 것 같아요 👍

codecov-commenter · 2024-06-25T08:04:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.60%. Comparing base (d58ba15) to head (38dc523).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #132   +/-   ##
=======================================
  Coverage   99.60%   99.60%           
=======================================
  Files          16       16           
  Lines         255      255           
  Branches       56       56           
=======================================
  Hits          254      254           
  Misses          1        1

Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]>

manudeli

간단한 의견을 남겨요

.github/CONTRIBUTING.md

Co-authored-by: Jonghyeon Ko <[email protected]>

manudeli

🚀🚀🚀🚀🚀

* 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]>

* fix. 겹모음과 관련된 이상 현상들 수정 * fix. fix index * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 업데이트 로직 반영 * test: internal 테스트 코드를 작성합니다 (#137) * test: internal 테스트 코드를 작성합니다 * test: vitest에서 제공해주는 toThrowError로 변경 --------- Co-authored-by: 박찬혁 <[email protected]> * docs: josa에 관련된 문서에 잘못된 부분을 수정합니다 - '이에/에' 삭제 Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#143) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 한글 문자열에 대한 검증, assert, parsing 함수를 구현합니다. (#136) * feat: 한글 문자열인지 boolean 반환 함수 * feat: 한글 문자열인지 assert 함수 * feat: stringify * test: isHangulString, assertHangulString 테스트 코드 * feat: parse 함수 * test: parse 함수 테스트 * refactor: naming 통일 * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) (#133) * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 * test 및 함수 추가 * add : 한글 문장인지 여부 판별 함수 추가 * fix : 한글 문장인지 여부 판별 기저 및 오류 추가 / arg 이름 변경 test 추가 * fix: src/_internal/hangul.ts Co-authored-by: 박찬혁 <[email protected]> * fix : rename function getFirstHangulLetters -> getHangulAcronym * fix : rename function export function isHangulOnly로 변경 * fix : lint error * fix : index에 추가 * chore : doc 추가 * fix : 문서화 한글 영어 바뀐거 바로 변경 * fix : isHangul로 대체 #136 으로 * chore : doc수정 * Update docs/src/pages/docs/api/getHangulAcronym.en.mdx Co-authored-by: 박찬혁 <[email protected]> * fix : Update hangul.ts 안쓰는 메소드 삭제 * Update getHangulAcronym.ko.mdx * Update getHangulAcronym.en.mdx * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update getHangulAcronym.ts * Update getHangulAcronym.spec.ts * Create fair-brooms-drive.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#145) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. (#130) * feat: parseHangul * fix: parseHangul의 이름을 extractHangul로 수정 및 테스트 코드 보완 * test: 일관된 테스트 코드 작성이 될 수 있도록 describe 설명 수정 * test: 테스트 코드 수정 * docs: extractHangul의 문서 작성 * test: 테스트 문구 수정 * fix: index.ts에 export 추가 * Create fresh-students-sit.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#146) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix : getHangulacronym함수를 acronymizeHangul 메서드로 대체합니다. (#148) * Update and rename getHangulAcronym.ts to acronymizeHangul.ts * Update and rename getHangulAcronym.spec.ts to acronymizeHangul.spec.ts * Update index.ts * Update and rename getHangulAcronym.en.mdx to acronymizeHangul.en.mdx * Update and rename getHangulAcronym.ko.mdx to acronymizeHangul.ko.mdx * Create odd-squids-sin.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#150) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 (#144) * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 * docs: amountToHangul의 영어 문서 작성 * Create famous-cheetahs-sneeze.md * Update famous-cheetahs-sneeze.md --------- Co-authored-by: 박찬혁 <[email protected]> * fix: packlint ESLint error (#149) * test: utils 기능들의 테스트 케이스를 개선합니다 (#151) * test: hasBatchim 함수의 테스트 케이스를 추가합니다 * test: hasSingleBatchim의 테스트 케이스를 추가합니다 * fix: nextra theme asset 개선 (#152) * chore: version packages (#153) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 패키지가 노출하는 인터페이스를 명확히 하기 위해 index.ts를 named export로 수정합니다 (#157) * fix: exposing public apis strictly * Create wild-cows-juggle.md * chore: version packages (#160) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * 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]> * test: amountToHangul 테스트 추가 (#135) * test: amountToHangul 테스트 추가 * test: amountToHangul 테스트 코드 수정 * test: amountToHangul 테스트 코드 스타일 변경 * test: amountToHangul test 개선 * fix: assert.throws대신 vitest toThrow로 메서드 변경 * fix: vitest toThrowError 메서드로 변경 --------- Co-authored-by: kinndohyun <[email protected]> Co-authored-by: 박찬혁 <[email protected]> * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 (#159) * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 * Create big-cups-call.md --------- Co-authored-by: 박찬혁 <[email protected]> * docs: acronymizeHangul 리턴 타입 표기 수정 (#161) * chore: version packages (#163) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 일관된 toThrowError 메서드 사용 (#166) Co-authored-by: kinndohyun <[email protected]> * chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 (#164) * chore(eslint): add cspell to check bad naming * chore: update * Create grumpy-singers-love.md --------- Co-authored-by: 박찬혁 <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jaemin Kim <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: seunghee <[email protected]> Co-authored-by: taehyun <[email protected]> Co-authored-by: SeongMin Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: 김도현 <[email protected]> Co-authored-by: kinndohyun <[email protected]> Co-authored-by: Song Hyo Jin <[email protected]> Co-authored-by: wnhlee <[email protected]>

* test: 음성 표기법 테스트 코드 작성 * test: isNotUndefined 유틸 구현 * test: 단일자모 테스트 케이스 추가 * test: 단일 자모 테스트 케이스 수정 * feat: 음성 표기법 기능 구현 * feat: 음절분해 속 disassembleCompleteHangulCharacter 함수는 undefined일 수 없음 * feat: 다음 음절 변수 조건식 강화 * refactor: 16항 -1 인덱스 조건 처리 * refactor: 16항 조건문 상수화하여 축약 * refactor: 음의 동화 조건 상수화 * refactor: ㄴ,ㄹ이 덧나는 경우 조건 상수화 * refactor: 19항 조건문 상수화 * refactor: 18항 조건문 상수화 * refactor: 20항 유음화 조건문 순서 수정 * refactor: 12항 조건에 상수화 적용 * refactor: 13,14항 상수화 및 반환타입추론 * refactor: 9,10,11항 조건문 상수화 * refactor: internal 함수 사용 * docs: phoneticNotation 문서 작성 * test: covertToRoman 테스트 코드 작성 * test: convertToRoman 테스트 케이스 추가 * feat: convertToRoman 구현 * refactor: 음절분해 return type 명시 * test: 테스트 케이스 수정 * docs: romanize * refactor: convertToRoman에서 romanize로 이름을 변경합니다. * refactor: phoneticNotation에서standardPronunciation으로 이름을 변경합니다 * feat: type guard include 함수를 구현합니다 * test: 경음화를 적용합니다 * feat: 경음화 기능을 옵션으로 추가합니다 * refactor: 표준발음 함수에서 사용되는 상수를 상수파일로 이동 * docs: 함수 설명문 수정 * docs: 표준발음법 문서 수정 * docs: 표준 발음법 영문 문서의 주석을 변경합니다 * test: isIncludedInArray 테스트 코드를 작성합니다 * fix: 특정회사 언급 문자 제거 * fix: 보다 간결하게 isIncludedInArray > arrayIncludes로 이름 변경 * fix: standardPronunciation 상수와 관련하여 새파일을 만든다 * fix: map 메소드를 축약한다 * fix: arrayIncludes > isArrayIncludes로 이름을 변경 * fix: arrayIncludes 함수를 개선합니다 * fix: romanize 가독성을 개선합니다 * fix: romanize > romanizeHangul #121 * refactor: 경음화 로직 분리 * refactor: nextSyllabel 연산 로직 축약 * refactor: 16항 로직 분리 * refactor: 17,19항 로직을 분리합니다 * refactor: 18항 로직을 분리합니다. * refactor: 불필요한 조건문 return 제거 * refactor: 12항 로직 분리 * refactor: 13,14 항 로직을 분리합니다 * refactor: 9,10,11항 로직 분리 * refactor: standardPronunciation 기능을 개별 폴더로 분리합니다 * refactor: ㄴ,ㄹ 동화작용 설명 추가 * refactor: standardPronunciation 조건문 중복 처리 * test: 경음화 등의 된소리를 적용하지 않는 테스트 케이스 추가 * refactor: 주요 로직 추상화 * fix: romanizeHangul에 일관된 변수명 적용 #131 * test: 한글과 영어가 혼합된 테스트 케이스를 추가합니다 * test: 테스트 케이스 예시를 변경합니다 * fix: ㄴ/ㄹ이 덧나는 경우에도 연음규칙 적용이 가능 * fix: 주석 변경 * fix: 이해하기 쉬운 용어로 주석 변경 * fix: 메서드 컨벤션을 적용합니다 #132 * fix: Received Object applyRules * fix: SRP 원칙 적용 - 1 * refactor: replace받침ㅎ * refactor: make pure function * refactor: applyRules * refactor: rule 별로 파일 분리 * refactor: rule naming 변경 * test: rules에 test case 추가 * fix: type import * fix: update import case * fix: isNotUndefined, defined, arrayIncludes를 internal로 이동합니다. * test: romanize test case 수정 * Create hip-pianos-live.md --------- Co-authored-by: 박찬혁 <[email protected]>

Update CONTRIBUTING.md

e08c928

okinawaa requested a review from raon0211 as a code owner June 25, 2024 02:02

vercel bot had a problem deploying to Preview June 25, 2024 02:02 Failure

okinawaa requested a review from manudeli June 25, 2024 02:02

manudeli reviewed Jun 25, 2024

View reviewed changes

po4tion mentioned this pull request Jun 26, 2024

feat: 한국어를 로마자로 변환해주는 함수와 한국어를 표준 발음법으로 변환해주는 함수를 만들고 문서화를 진행합니다 #115

Merged

1 task

okinawaa requested review from po4tion and manudeli June 29, 2024 11:28

po4tion approved these changes Jun 29, 2024

View reviewed changes

fix

5f563be

vercel bot had a problem deploying to Preview June 30, 2024 01:27 Failure

okinawaa requested a review from po4tion June 30, 2024 01:28

manudeli assigned okinawaa Jun 30, 2024

po4tion approved these changes Jul 1, 2024

View reviewed changes

okinawaa and others added 2 commits July 2, 2024 21:05

write contribution.md

830e915

Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]>

Merge branch 'main' into okinawaa-patch-3

43c46c5

okinawaa requested review from manudeli and removed request for manudeli July 2, 2024 12:05

vercel bot deployed to Preview July 2, 2024 12:08 View deployment

po4tion added a commit to po4tion/es-hangul that referenced this pull request Jul 2, 2024

fix: 메서드 컨벤션을 적용합니다 toss#132

59c79fd

manudeli reviewed Jul 3, 2024

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

.github/CONTRIBUTING.md Show resolved Hide resolved

manudeli reviewed Jul 3, 2024

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

okinawaa and others added 3 commits July 3, 2024 12:06

Update .github/CONTRIBUTING.md

968ba68

Co-authored-by: Jonghyeon Ko <[email protected]>

Update .github/CONTRIBUTING.md

f44d801

Co-authored-by: Jonghyeon Ko <[email protected]>

Update .github/CONTRIBUTING.md

38dc523

Co-authored-by: Jonghyeon Ko <[email protected]>

okinawaa requested a review from manudeli July 3, 2024 03:06

vercel bot deployed to Preview July 3, 2024 03:08 View deployment

manudeli approved these changes Jul 3, 2024

View reviewed changes

okinawaa merged commit 11e0ba9 into main Jul 3, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

okinawaa commented Jun 25, 2024

vercel bot commented Jun 25, 2024 •

edited

Loading

changeset-bot bot commented Jun 25, 2024 •

edited

Loading

manudeli Jun 25, 2024

okinawaa Jun 25, 2024

manudeli Jun 25, 2024 •

edited

Loading

po4tion Jun 25, 2024 •

edited

Loading

po4tion Jun 25, 2024

po4tion Jun 30, 2024

okinawaa Jun 30, 2024

Collection50 Jul 1, 2024 •

edited

Loading

okinawaa Jul 2, 2024

Collection50 Jul 2, 2024

codecov-commenter commented Jun 25, 2024 •

edited

Loading

manudeli left a comment

manudeli left a comment •

edited

Loading

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

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

Conversation

okinawaa commented Jun 25, 2024

Overview

PR Checklist

vercel bot commented Jun 25, 2024 • edited Loading

changeset-bot bot commented Jun 25, 2024 • edited Loading

⚠️ No Changeset found

manudeli Jun 25, 2024

Choose a reason for hiding this comment

okinawaa Jun 25, 2024

Choose a reason for hiding this comment

manudeli Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

po4tion Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

po4tion Jun 25, 2024

Choose a reason for hiding this comment

po4tion Jun 30, 2024

Choose a reason for hiding this comment

okinawaa Jun 30, 2024

Choose a reason for hiding this comment

Collection50 Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

okinawaa Jul 2, 2024

Choose a reason for hiding this comment

Collection50 Jul 2, 2024

Choose a reason for hiding this comment

codecov-commenter commented Jun 25, 2024 • edited Loading

Codecov Report

manudeli left a comment

Choose a reason for hiding this comment

manudeli left a comment • edited Loading

Choose a reason for hiding this comment

vercel bot commented Jun 25, 2024 •

edited

Loading

changeset-bot bot commented Jun 25, 2024 •

edited

Loading

manudeli Jun 25, 2024 •

edited

Loading

po4tion Jun 25, 2024 •

edited

Loading

Collection50 Jul 1, 2024 •

edited

Loading

codecov-commenter commented Jun 25, 2024 •

edited

Loading

manudeli left a comment •

edited

Loading