We welcome you to join the development of Hexo. ๐ค
๊ฐ๋ฐ
์ฐ๋ฆฌ๋ ๋น์ ์ด Hexo์ ๊ฐ๋ฐ์ ์ฐธ์ฌํ๋ ๊ฒ์ ํ์ํฉ๋๋ค. ์ด ๋ฌธ์๋ ๋น์ ์ ๊ฐ๋ฐ ํ๋ก์ธ์ค์ ๋์์ ์ค ๊ฒ๋๋ค.
์์ํ๊ธฐ ์ ์โฆ
Please read Contributor Covenant Code of Conduct first.
์๋์ ์ฝ๋ฉ ์คํ์ผ์ ์ง์ผ์ฃผ์ธ์.
- Google JavaScript Style Guide๋ฅผ ๋ฐ๋ฆ ๋๋ค.
- ๋ ๊ฐ์ ๊ณต๋ฐฑ์ ์ฌ์ฉํ soft-tab์ ์ฌ์ฉํฉ๋๋ค.
- ์ฝค๋ง๋ก ์์ํ์ง ๋ง์ธ์.
Also, Hexo has its own ESLint config, so please make sure your contribution will make ESLint happy.
Workflow
- Fork hexojs/hexo.
- ์ ์ฅ์๋ฅผ ๋น์ ์ ์ปดํจํฐ์ cloneํ๊ณ ์์กด ์ฌํญ๋ค์ ์ค์นํฉ๋๋ค.
$ git clone https://github.com/<username>/hexo.git |
- ๊ธฐ๋ฅ branch๋ฅผ ์์ฑํฉ๋๋ค.
$ git checkout -b new_feature |
- Start hacking.
- Branch๋ฅผ pushํฉ๋๋ค.
$ git push origin new_feature |
- ๋ณ๊ฒฝ์ฌํญ์ ๋ํ ์ค๋ช ์ ํฌํจํ์ฌ 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
- Fork hexojs/site
- ์ ์ฅ์๋ฅผ ๋น์ ์ ์ปดํจํฐ์ cloneํ๊ณ ์์กด ์ฌํญ๋ค์ ์ค์นํฉ๋๋ค.
$ npm install hexo-cli -g # If you don't have hexo-cli installed |
- ๋ฌธ์๋ฅผ ์์ ํ์ธ์. Server๋ฅผ ๋๋ ค์ ์ค์๊ฐ์ผ๋ก ํ์ธํ ์ ์์ต๋๋ค.
$ hexo server |
- Branch๋ฅผ pushํฉ๋๋ค.
- ๋น์ ์ ๋ณ๊ฒฝ์ฌํญ์ ๋ํ ์ค๋ช ์ ํฌํจํ์ฌ Pull request๋ฅผ ์์ฑํฉ๋๋ค.
๋ฒ์ญ
source
ํด๋ ์์ ์ ์ธ์ด์ ๋ํ ํด๋๋ฅผ ์์ฑํ์ธ์. (์๋ฌธ์๋ก ์์ฑํ์ธ์.)source
ํด๋์ Markdown ๋ฐ ํ ํ๋ฆฟ ํ์ผ๋ค์ ์ ์ธ์ด ํด๋์ ๋ณต์ฌํ์ธ์.source/_data/language.yml
์ ์ ์ธ์ด๋ฅผ ์ถ๊ฐํ์ธ์.themes/navy/languages
์en.yml
ํ์ผ์ ๋ณต์ฌํ๊ณ ์ ์ธ์ด๋ก ์ด๋ฆ์ ๋ณ๊ฒฝํ์ธ์. (์๋ฌธ์๋ก ๋ณ๊ฒฝํ์ธ์.)
์ด์ ๋ณด๊ณ
Hexo๋ฅผ ์ฌ์ฉํ๋ค๊ฐ ๋ฌธ์ ๋ฅผ ๋ฐ๊ฒฌํ๋ฉด, Troubleshooting, GitHub, Google Group์์ ์ด์์ ๋ํด ๋ต์ ์ฐพ์๋ณด์ธ์. ๋ง์ฝ ๋ต์ด ์๋ค๋ฉด Github์ ๋ฌธ์ ๋ฅผ ๋ณด๊ณ ํด ์ฃผ์ธ์.
- ๋ฌธ์ ์ฌํ์ debug mode์์ ํด์ฃผ์ธ์.
- Follow the steps from issue template to provide debug message and version when submitting a new issue at GitHub.