Before opening a pull request, be sure to read this Pull Request Etiquette blog post.
- Hugo extended installed globally.
- On Windows (Chocolatey):
choco upgrade hugo-extendedFrom the repository root:
- Start the local dev server (includes draft content):
hugo server -D- Open the local site (default):
http://localhost:1313/ - Build a production version:
hugo build- Optional: lint markdown content files:
markdownlint content/- Choose the correct section folder under
content/(for example:antipatterns,principles,practices,testing). - Create a new page using a kebab-case slug:
hugo new content/<section>/<slug>.mdExample:
hugo new content/principles/example-principle.md- Update frontmatter. Most pages include at least:
---
title: Example Principle
date: 2026-03-14
description: One or two concise sentences summarizing the article.
params:
image: /principles/images/example-principle.png
weight: 10
---- Add the article body content, links, and references.
- Run
hugo server -Dand verify the page renders and appears in the expected section. - When the article is ready to publish, ensure
draftis removed or set tofalse.
We have a process for creating a featured image using Canva:
- The DevIQ template is read-only on Canva. Make a copy of the file in Canva by going to File > Make a copy.
- Update the title.
- Find an appropriate background by going to Elements > Photos and search.
- Drag the photo to the canvas, towards the middle of the image.
- Right-click on the image and select Replace background.
- Download the image and save it in the respective
imagesfolder. - Update the frontmatter for the new page with the correct file name.