mirror of
https://github.com/hugo-fixit/FixIt.git
synced 2026-08-24 15:28:57 +00:00
Cell
3ffef8acb0
* 🔍 Refactor: add JSON feed support and refactor output formats build in FixIt Close #475 * 🚚 Feat: migrate index templates to layouts/_default folder and home.[name].html * 📝 Style(ignore): fix typo * 🚚 Chore: migrate index templates to default home templates * 🚚 Chore: migrate section templates to layouts/section folder * ✨ Feat: add JSON feed support for section pages (#475) * 🚧 Feat: add common template for JSON feed (#475) * 🚧 Feat: add JSON feed support for section and term list pages * 🚀 Chore: fix git stage error in update-version script * ⚡ Perf: add front matter hiddenFromFeed for JSON feed (#475) * 🔍 Feat: add tags attribute for JSON feed (#475) * ♻️ Refactor: refactor RSS feed templates Close #488 * 🚧 WIP: rename json-feed.html to json.html * 🚧 Feat: revert single.md * ⚡ Perf: enhance JSON feed 1.1 compatibility * ♻️ Refactor: refactor post author map getting * ✨ WIP: add featured image support in feed * 📝 Docs: update README and screenshot * 🔧 Chore: update changelog template * 🚧 WIP: add feed scoped config for section and list * 🔥 Feat: migrate JSON feed to hugo-fixit/hugo-json-feed Close hugo-fixit/hugo-json-feed#1 * 🚚 Feat: remove front matter hiddenFromRss and rssFullText, add front matter hiddenFromFeed
93 lines
5.0 KiB
Markdown
93 lines
5.0 KiB
Markdown
# CONTRIBUTING
|
|
|
|
Make sure that you follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) while contributing and engaging in the discussions.
|
|
|
|
## How to contribute to this project
|
|
|
|
First, fork this repository by clicking the fork button.
|
|
|
|
Next, clone your forked repo.
|
|
|
|
```bash
|
|
git clone https://github.com/hugo-fixit/FixIt.git && cd FixIt
|
|
```
|
|
|
|
Then, install the dev dependencies.
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
And now you are ready to go!
|
|
|
|
Here are some useful commands.
|
|
|
|
```bash
|
|
# 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:
|
|
|
|
```bash
|
|
npm run server:docs
|
|
```
|
|
|
|
Finally, create a new pull request at <https://github.com/hugo-fixit/FixIt/pulls> to submit your contribution 🎉
|
|
|
|
## Git standard for developers
|
|
|
|
### Branches
|
|
|
|
| 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_ |
|
|
|
|
### Merge events
|
|
|
|
| event | merge |
|
|
| :-- | :-- |
|
|
| release | **dev => master:** `--rebase` |
|
|
| PR | **others:master => master:** `--rebase` |
|
|
| single feature| **feature branch => dev/master:** `--merge` |
|
|
|
|
### Commit message
|
|
|
|
#### Format
|
|
|
|
`[{emoji} ]{type}[({scope})]: {subject within 50 words}[ (#{issue/pull request})]`
|
|
|
|
example:
|
|
|
|
- :tada: Feat: add shortcode fixit-encryptor shortcode (#123)
|
|
- :arrow_up: Chore(libs): update Artalk from 2.2.12 to 2.3.4 (#150)
|
|
|
|
#### Emoji
|
|
|
|
- <https://gitmoji.dev>
|
|
- [vscode plugin](https://github.com/maixiaojie/git-emoji-zh.git)
|
|
- utools plugin `GitEmoji`
|
|
|
|
#### Message
|
|
|
|
| Emoji | Type | Example | Description (No Ambiguous) |
|
|
| :-------------------------------------------- | :------- | :----------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| :tada:<br>:sparkles: | Feat | Feat: add {feature} | new feature |
|
|
| :truck: | | Feat: adjust/migrate {feature name}, {change details} | For the adjustment feature, it is necessary to describe the current situation (before) and after adjustment (after) |
|
|
| :fire: | | Feat: delete {feature name}, {deletion reason} | If the feature is deleted, the reason for deletion must be explained |
|
|
| :bug: <br>:construction: <br>:rotating_light: | Fix | Fix: fix {bug description} | Fix known bugs |
|
|
| :art: <br>:lipstick: <br>:pencil2: | Style | Style: Typesetting/CSS style {optimizing content} | Changes that do not affect code operation, such as code layout and style change |
|
|
| :recycle: | 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 |
|
|
| :zap: | Perf | Perf: improve performance {function name}, {improve content} | Optimize code performance |
|
|
| :rewind: | Revert | Revert: restore version {commit message of restore version} | Restore the version of one commit |
|
|
| :pencil:<br>:pencil2: | Docs | Docs: revise comments/update documents | Adjustment of documents and notes |
|
|
| :wrench: | 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.
|