Contributing

We welcome you to join the development of Hexo. 🤗

개발

우리는 당신이 Hexo의 개발에 참여하는 것을 환영합니다. 이 문서는 당신의 개발 프로세스에 도움을 줄 겁니다.

시작하기 전에…

Please read Contributor Covenant Code of Conduct first.

아래의 코딩 스타일을 지켜주세요.

Also, Hexo has its own ESLint config, so please make sure your contribution will make ESLint happy.

Workflow

  1. Fork hexojs/hexo.
  2. 저장소를 당신의 컴퓨터에 clone하고 의존 사항들을 설치합니다.
$ git clone https://github.com/<username>/hexo.git
$ cd hexo
$ npm install
$ git submodule update --init
  1. 기능 branch를 생성합니다.
$ git checkout -b new_feature
  1. Start hacking.
  2. Branch를 push합니다.
$ git push origin new_feature
  1. 변경사항에 대한 설명을 포함하여 Pull request를 생성합니다.

공지사항

  • package.json의 version number는 수정하지 마세요.
  • 당신의 Pull request는 테스트를 통과했을 때에만 merge됩니다. 반영하기 전에 test를 돌려보세요.
$ npm test

Updating official-plugins

Also, we welcome PR or issue to official-plugins. 🤗

문서의 갱신

Hexo 문서는 opensource이며 hexojs/site에서 소스 코드를 검색할 수 있습니다.

Workflow

  1. Fork hexojs/site
  2. 저장소를 당신의 컴퓨터에 clone하고 의존 사항들을 설치합니다.
$ npm install hexo-cli -g # If you don't have hexo-cli installed
$ git clone https://github.com/<username>/site.git
$ cd site
$ npm install
  1. 문서를 수정하세요. Server를 돌려서 실시간으로 확인할 수 있습니다.
$ hexo server
  1. Branch를 push합니다.
  2. 당신의 변경사항에 대한 설명을 포함하여 Pull request를 생성합니다.

번역

Contribute translations

Crowdin

Now we use the Crowdin platform for translation, where anyone can contribute translations and vote for translations without manual git operations.

Add a new language

  1. Submit a new issue to let us know. The members with access to the Crowdin Project add the language in settings.
  2. After adding language in Crowdin, anyone can contribute translations on it.
  3. source/_data/language.yml에 새 언어를 추가하세요.
  4. themes/navy/languages에 en.yml 파일을 복사하고 새 언어로 이름을 변경하세요. (소문자로 변경하세요.)

이슈 보고

Hexo를 사용하다가 문제를 발견하면, Troubleshooting, GitHub, Google Group에서 이슈에 대해 답을 찾아보세요. 만약 답이 없다면 Github에 문제를 보고해 주세요.

  1. 문제 재현은 debug mode에서 해주세요.
  2. Follow the steps from issue template to provide debug message and version when submitting a new issue at GitHub.
Next