Fetch the repository succeeded.
First, fork this repository by clicking the fork button.
Next, clone your forked repo.
git clone https://github.com/hugo-fixit/FixIt.git && cd FixIt
Then, install the dev dependencies.
npm install
And now you are ready to go!
Here are some useful commands.
# run a local debugging server with watch
npm run server
# run a local debugging server with watch in production environment
npm run server:production
If you want to do docs-related theme changes, the simplest way is to have both FixIt
and fixit-docs
cloned as sibling directories, and then run:
npm run server:docs
Finally, create a new pull request at https://github.com/hugo-fixit/FixIt/pulls to submit your contribution 🎉
Branch | Description |
---|---|
master | The branch open to the public and release versions |
dev | The development branch of the next version |
RC branch | The release candidate branch of the next version, e.g. v0.2.12-RC |
single feature | The branch to enhancements or fixes |
event | merge |
---|---|
release |
RC branch => master: --rebase
|
PR |
others:master => master: --rebase
|
single feature |
feature branch => RC branch: --merge
|
[{emoji} ]{type}[({module})]: {subject within 50 words}[ (#{issue/pull request})]
example:
GitEmoji
Emoji | Type | Example | Description (No Ambiguous) |
---|---|---|---|
|
Feat | Feat: add {feature} | new feature |
Feat: adjust/migrate {feature name}, {change details} | For the adjustment feature, it is necessary to describe the current situation (before) and after adjustment (after) | ||
Feat: delete {feature name}, {deletion reason} | If the feature is deleted, the reason for deletion must be explained | ||
|
Fix | Fix: fix {bug description} | Fix known bugs |
|
Style | Style: Typesetting/CSS style {optimizing content} | Changes that do not affect code operation, such as code layout and style change |
Refactor | Refactor: override {feature name} | It is neither a new function nor a code change to fix a bug. Simply rewriting the code of a function does not affect the function result | |
Perf | Perf: improve performance {function name}, {improve content} | Optimize code performance | |
Revert | Revert: restore version {commit message of restore version} | Restore the version of one commit | |
|
Docs | Docs: revise comments/update documents | Adjustment of documents and notes |
Chore | Chore: update plugin version | Changes in the construction process or auxiliary tools |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。