mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git

edit | blame | history | raw

Contributing to ananke

Thanks for helping improve Ananke. This document describes the current contribution workflow for this repository.

Ways to contribute

  • Report bugs
  • Suggest enhancements
  • Improve documentation
  • Improve templates, styles, or assets
  • Improve translations in i18n/*.toml

Release process

The project follows a structured release workflow based on conventional commits, staging branches, and automated versioning.

For details, see Branch Strategy. Publish a stable theme release from main before publishing the matching documentation. The documentation production build resolves the latest stable theme without changing its checked-in dependency files; preview builds can select an unreleased ref. Follow the release and publication order, and confirm the resolved theme version in the documentation build log.

Before you start

  1. Use a compatible Hugo version (see config/_default/module.toml for the current state).
  2. Install dependencies:
npm install
  1. Run a local preview via npm run instead of just calling hugo server:
npm run dev

This runs the sibling documentation/ site with the local Ananke working tree. Keep both repositories next to each other, install the documentation dependencies, and use Node.js 22.18 or later. The calling repository stays on its branch: main selects the companion's main, development selects development, and other named branches select the same local branch in the companion when it exists. Otherwise, they select development. The launcher prints both branches and any switch it makes, and stops if the companion needs switching but has uncommitted or untracked changes (excluding scratch/). Stop the server before selecting another branch pair. You can run the same command from either repository; see the documentation development guide.

  1. Follow the coding style and format commit messages as described in the conventional commits specification (for example: docs: add troubleshooting section or fix: correct hero image path).

  2. Make sure to install git hooks for linting and testing before you push changes:

npm run prepare

This command is run automatically after npm install but you can run it manually to set up hooks in an existing clone or update changed hooks. It uses simple-git-hooks to install a commit hook that runs lint-staged for markdown files, which in turn runs linting tasks on staged files.

Reporting bugs and requesting features

  • Open bugs in GitHub Issues.
  • Start feature or idea discussions in GitHub Discussions.
  • Include clear reproduction steps, expected behaviour, actual behaviour, and versions (hugo version, OS, browser if relevant).

Branch strategy

flowchart LR
 feature["feature/*, fix/*, docs/*, refactor/*"] --> development
 development --> main
 main --> development

This repository uses a linear, rebase-based branch model. Long-lived branches MUST stay connected to main, and merge commits MUST NOT be introduced.

Long-lived branches

Branch Purpose Release role Write policy Merge
main Stable source of truth releases Protected. Only receives reviewed PRs from development. Rebase
development Active development pre-releases Feature, fix, chore, and documentation PRs target this branch. Squash

Branch naming

Use short-lived branches for regular work:

  • feat/<topic>
  • fix/<topic>
  • docs/<topic>
  • chore/<topic>
  • refactor/<topic>

After a successful rebase between those branches, push with lease:

git push --force-with-lease

Tests

Run the relevant theme test commands for each change and register changed parameters or shortcodes in tests/catalog.yaml. npm test uses the Node test runner and feature mini-sites; browser, static, visual, and Lighthouse checks have separate commands. The coverage gate checks registration and test paths, not complete behavioural coverage.

Follow the manual testing guide after relevant UI changes and for release candidates. Record the tested commit, environment, scope, and findings in the pull request or release record. Initial screenshot approval establishes a starting point; changed screenshots and relevant accessibility behaviour need fresh review.

Pull request workflow

  1. Fork the repository and create a focused branch.
  2. Keep the change set small and cohesive (which means, DO NOT introduce multiple changes in a single PR).
  3. Update docs for all user-facing changes.
  4. Run quality checks locally:
npm run lint:markdown
  1. If your change affects behaviour, validate with Hugo locally (for example hugo or hugo server in the relevant project).
  2. Open a pull request with:
  • a clear summary,
  • motivation/context,
  • screenshots when UI/visual output changes,
  • linked issues (for example: Fixes #123).

Circumventing git hooks

To prevent git commit and git push from running hooks you can use the --no-verify flag:

git commit --no-verify -m "docs: update README"
git push --no-verify origin my-feature-branch

This should be used sparingly and only when you have a good reason to bypass checks. If you find yourself needing to use --no-verify frequently, please consider improving the hooks or contributing fixes to reduce false positives.

Documentation contributions

The theme documentation lives in a separate repository at gohugo-ananke/documentation.

Please keep links relative where possible and remove stale references when updating pages.

Attribution

If you want to receive attribution for your contribution please follow the contribution guidelines to add yourself to the list of contributors in the Ananke theme documentation. A permanently open issue to add your contribution can be found at the documentation repository. Read the initial message to understand how to add yourself to the list of contributors.

License

By contributing, you agree that your contributions are provided under the repository license in LICENSE.md.