FixIt/CONTRIBUTING.md

CONTRIBUTING

Make sure that you follow CODE_OF_CONDUCT.md while contributing and engaging in the discussions.

Prerequisites

Before you start contributing, make sure you have the following tools installed:

• Node.js (>= 18.0.0) - Required for package management and build tools
• Hugo Extended (>= 0.147.7) - The static site generator
• pnpm - Package manager (recommended)

You can check your installed versions:

node --version
hugo version
pnpm --version

How to contribute to this project

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.

pnpm install

And now you are ready to go!

Here are some useful commands for development:

Development Server

# Run a local development server with live reload
pnpm server

# Run a local development server in production environment
pnpm server:production

Documentation Development

If you want to work on documentation-related theme changes, the simplest way is to have both FixIt and fixit-docs cloned as sibling directories, and then run:

# Run documentation server
pnpm server:docs

Testing

# Run test server with test content
pnpm test

# Run test server in production environment
pnpm test:production

Building

# Build demo site
pnpm build

# Build test site
pnpm build:test

Project Structure

Understanding the project structure will help you contribute more effectively:

FixIt/
├── archetypes/         # Content templates
├── archetypes/         # Archetypes 
├── assets/             # Theme assets (CSS, JS, images)
│   ├── css/            # SCSS stylesheets
│   ├── js/             # JavaScript files
│   └── lib/            # Third-party libraries
├── demo/               # Demo site for development
├── i18n/               # Internationalization files
├── layouts/            # Hugo template files
│   ├── _markup/        # Hugo render hooks
│   ├── _partials/      # Reusable template components
│   └── _shortcodes/    # Custom shortcodes
├── static/             # Static files
├── test/               # Test site content
├── package.json        # npm scripts and dependencies
└── hugo.toml           # Default theme configuration

Development Workflow

1. Make your changes in the appropriate directories
2. Test locally using pnpm server or pnpm test
3. Check different environments with production builds
4. Verify documentation changes with pnpm server:docs (if applicable)
5. Commit your changes following the commit message format below

Pull Request Guidelines

• Create a feature branch from main
• Make your changes with clear, focused commits
• Test your changes thoroughly
• Update documentation if needed
• Submit a pull request with a clear description

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
main	The development branch, may contain unstable updates
single feature	The branch to enhancements or fixes

Merge events

event	merge
PR	others:main => main: --rebase
single feature	feature branch => main: --merge

Commit message

Format

[{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)

Emoji

• https://gitmoji.dev
• vscode plugin
• utools plugin GitEmoji

Message

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.
A add (ignore) or (i) scope to ignore including in.