Make sure that you follow CODE_OF_CONDUCT.md while contributing and engaging in the discussions.
First, fork this repository by clicking the fork button.
Next, clone your forked repo.
git clone https://github.com/hugo-fixit/FixIt.git && cd FixItThen, install the dev dependencies.
npm installAnd 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:productionIf 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:docsFinally, 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 |
| single feature | The branch to enhancements or fixes |
| event | merge |
|---|---|
| release | dev => master: --rebase |
| PR | others:master => master: --rebase |
| single feature | feature branch => dev/master: --merge |
[{emoji} ]{type}[({scope})]: {subject within 50 words}[ (#{issue/pull request})]
example:
- 🎉 Feat: add shortcode fixit-encryptor shortcode (#123)
- ⬆️ Chore(libs): update Artalk from 2.2.12 to 2.3.4 (#150)
- https://gitmoji.dev
- vscode plugin
- utools plugin
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 |
Note
The change log is automatically generated based on the commit message.
Use Chore type or add (ignore) scope to ignore including in.