clean.js는 언제나 열려있습니다. 아무때나, 편하게 오셔서 커밋한번 하고 가세요~!
___ __ ____ __ _ _ ____ ___
/ __)( ) ( ___) /__\ ( \( ) (_ _)/ __)
( (__ )(__ )__) /(__)\ ) ( .-_)( \__ \
\___)(____)(____)(__)(__)(_)\_)()\____) (___/
깨끗하게 맑게 자신있게~! 누구나 읽기 쉽도록 깔끔하게 코드를 작성해봅시다. JavaScript 공부 하시는 분들께도 도움이 되는 프로젝트를 만들고 싶어요.
- 쉽고 재밌는 개발을 하자!를 원칙으로 하고있어요!
- 문서가 필요없이 소스만 봐도 뭔지 아는 그정도로 쉬운 코드 작성을 목표로 하고있어요!
- 정말 다 바꾸셔도 되요! (지금 보시는 문서도 바꾸셔도 되고요!) 자유롭고 제한 없는 커밋을 원합니다!
- push가 잘 안되시면 pull을 먼저 받고 해보세요!
- clean.js는 누구에게나 열려있어요. clean.js 유저 그룹( https://www.facebook.com/groups/cleanjs )에서 커미터 신청을 부탁드립니다 :)
- @cleanjs.org 메일 주소 신청받아요~! 네이버 메일과 연동할 수 있어요!
- 코드 공부하시다가 설명이 부족하다 싶은 부분은 이해하시는 대로 주석으로 남겨주세요!
node.js
npm install clean.js
현재 패키지 버젼 0.0.2 입니다 :)
목표
underscore.js( http://underscorejs.org )를 뛰어넘는 멋진 JavaScript 라이브러리!
목표 달성! 이번엔 jQuery?
이것만은 지켜주세요!
- 부담없이 막 올려주세요! 주석이라도 좋으니 1일 1커밋을 해봅시다!
- 주석은 백만줄이라도 좋으니 팍팍 달아주세요. 한글로 상세하게 설명할수록 좋아요.
- 내가 만족하는 코드가 아닌 다른 사람이 '보기 좋은' 코드를 작성해주세요!
- 부담없이 커밋해 주세요! 작성하신 코드를 다른 사람들이 더 발전시켜 줄거에요! :)
- 때에 따라서는 지워질수도 있어요! ;(
- 기능들은 clean.{패키지 명}.{기능 명} 으로 작성해주세요~!
- 기능 하나에 파일 하나! clean.is.good 이라는 기능은 is폴더 안에 good.js로 만들어주세요!
- 모든 기능은 function으로 만들어주세요 순!수!함!수! :)
- 파라미터가 필수인것과 아닌것을 구별해주세요!
- //REQUIRED: param1
- //OPTIONAL: param2
- 이 외에는 딱히 제한이 없어요.
테스트 방법
- source에 코드를 작성해요!
- root 폴더에서 node build를 입력해요! 그럼 clean.js가 새로 만들어집니다!
(참고로 nodemon이 설치되어 있으면 nodemon build 이렇게 해두면 source 수정할 때마다 자동으로 빌드함!) - test 폴더에 테스트용 html파일을 아무렇게나 작성하여 실행합니다!!
QUnit
- QUnit( https://qunitjs.com )은 clean.js의 공식 테스트 프레임워크입니다.
호환성
- clean.js는 ECMAScript 5 스펙에 맞추어 개발됩니다. (ES5는 IE 9 이상부터 지원합니다.)
향후 로드맵
-
1차 로드맵
1차 로드맵은 스터디 기반 lib인 만큼, jQuery등 유명 lib를 학습하다 구현이 어떻게 되어있는지 직접 구현해 보면서 clean.js에 기능들을 추가하는, 실제 현업에 쓰이고 있는 수많은 lib들의 좋은 점들만 가져오는 lib로 발전시키는 것입니다. 현재 underscore의 기능들은 모두 접목이 되어 있는 상황입니다. -
2차 로드맵
2차 로드맵은 lib에서 조금 더 나아가, MVC 패턴 등을 구현하여 프레임워크로 발돋음 할지, node.js쪽 지원을 더 강화할지 등 커미터 여러분들과 상의해서 결정해 나가려고 합니다. 커미터분들께서 더 관심있어 하는 방향으로 자연스럽게 흘러가겠지요?! :) -
최종 목표!
국내 JS 개발자들의 집단지성으로 만들어진 국산 JS프로젝트가, 해외 커뮤니티들에서 나온 것들에 뒤지지 않는 멋진 프로젝트로 발돋음 하는 것입니다.