Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 2.15 KB

CONTRIBUTE

환영합니다 🎉🥳 :)

이곳은 DICTIONARY에 기여하는 방법을 설명하는 문서입니다.

만약 기타 다른 질문이 있다면 ISSUE에 어떠한 것이라도 남겨주세요.

기여 방법은 총 세 가지 입니다.

1. 단어 추가 및 수정

추가 했으면 하는 단어, 혹은 수정되어야 하는 단어를 DICTIONARY의 양식에 맞게 작성하여 PR(PULL REQUEST)를 생성해주세요.

📄 추가방법

DICTIONARY는 DICTIONARY SPEC이 존재 합니다. 단어를 추가하려면 해당 SPEC에 맞추어서 제출하셔야 합니다. 작성 후에 inspect.js 혹은 inspect.py를 실행 시키거나 에디터를 사용한다면 스펙에 대한 문법 검사를 실행할 수 있습니다.

🚀 에디터로 새로운 단어 추가하기

DICTIONARY-EDITOR Beta 버전이 출시되었습니다.

양식을 입력 후에 복사해서 바로 제안 할 수 있습니다.

https://meotitda.github.io/DICTIONARY-EDITOR/

작성 파일은 반드시 *.md(마크다운) 파일로 생성하셔야 합니다.

🆕 로컬에서 새로운 단어 추가하기

다음 명령어를 통해 포맷에 맞는 예제를 생성합니다.

프로젝트 Root 위치에서 환경에 따라 다음 파일을 실행 시킵니다.

Window (.exe)

./run.exe [추가하려는 단어]

Mac Os, Linux (Shell)

sh new.sh [추가하려는 단어]

Node.js

node new.js [추가하려는 단어]

Python

python new.py [추가하려는 단어]

2. DICTONARY DOC

📄 문서 수정

해당 페이지내의 문서에 대한 수정 제안을 할 수 있습니다.

3. 🤩 GOOD ISSUE

DICTIONARY는 아직 많은 아이디어와 기능이 필요합니다.

또한 초기 단계라 버그가 발생할 수 있습니다.

issue를 생성해서 다양한 아이디어 혹은 버그 리포팅을 해주세요!