Contributing

Code Quality

A new release can happen at any time from the main branch of the GitHub project without further acknowledgment. This makes it necessary that, every pushed set of changesets into the main branch must be self-contained and correct, resulting in a releasable version.

Stay simple for the user by focusing on the mantra “convention over configuration”.

At installation the site should work reasonable without (m)any configuration.

Stay close to the Hugo way.

Don’t use npm or any preprocessing, our contributors may not be front-end developers.

Document new features in the docs. This also contains entries to the What’s new page.

Don’t break existing features if you don’t have to.

Remove reported issue from the browser’s console.

Check for unnecessary whitespace and correct indention of your resulting HTML.

Conventional Commits

Write commit messages in the conventional commit format.

Following is an incomplete list of some of the used conventional commit types. Be creative.

Maintaining

Semver

This project tries to follow the semver policy - although not followed 100% in the past.

Usually an entry of Breaking on the What’s new page causes a new major release number.

All other entries on the What’s new page will increase the minor release number.

Releases resulting in a new major or minor number are called main release.

Releases containing bugfixes only, are only increasing the patch release number. Those releases don’t result in announcements on the What’s new page.

Entries on the What’s new page are checked and enforced during the version-release GitHub Action.

Managing Issues

Issues are categorized and managed by assigning labels to it.

Once working on an issue, assign it to a fitting maintainer.

When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.

A once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.

Managing Pull Requests

If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.

You can assign multiple PRs to one issue as long as they belong together.

Usually set the same labels and milestone for the PR as for the accompanied issue.

Labels

Kind

An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.

Impact

If the issue would cause a new main release due to semver semantics it needs one of the according labels and the matching badge on the What’s new page.

Declination

If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.

Halt

You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.

3rd-Party

If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.

Setting Up a Development Environment

Git Hooks are used to automate some tasks. They are stored in the .githooks root folder.

Documentation for each hook is contained in each file.

At least the pre-commit hook is required, as it updates the version number on each commit. This helps to help debugging of user related issues.

Making Releases

A release is based on a milestone named like the release itself - just the version number, eg: 1.2.3. It’s in the maintainers responsibility to check semver semantics of the milestone’s name prior to release and change it if necessary.

Making releases is automated by the version-release GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the main branch of the repository.

Treat released milestones as immutable. Don’t rerelease an already released milestone. An already released milestone may already been consumed by your users.

During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.

The following checks will be enforced

• the milestone exists
• there is at least one closed issue assigned to the milestone
• all assigned issues for this milestone are closed
• if it’s a main release, there must be an accompanying releasenotes file present in the repo at introduction/releasenotes/<major>/<minor>.en.md

After a successful run of the action

• the changelog at introduction/changelog/<major>/<minor>/<patch>.<lang>.md is created for english and piratish, including missing generic upper level files
• the CHANGELOG.md is updated
• the releasenotes at introduction/releasenotes/<major>/<minor>.en.md are updated, including release version and release date
• missing generic upper level files for english and piratish are created
• the version number for the <meta generator> is updated
• the updated files are committed
• the milestone is closed
• the repository is tagged with the version number (eg. 1.2.3), the main version number (eg. 1.2.x) and the major version number (eg. 1.x)
• a new entry in the GitHub release list with the according changelog will be created
• the official documentation is built and deployed
• the version number for the <meta generator> is updated to a temporary and committed (this helps to determine if users are running directly on the main branch or are using releases)
• a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)

Screenshots

Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings

Common

Creation:

• Use English translation
• Empty search
• Remove history checkmarks but leave it on the page thats used for the screenshot
• After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position

Demo Screenshot

Content:

A meaningful full-screen screenshot of an interesting page.

The content should be:

• timeless: not showing any dates or often edited content
• interesting: show a bunch of interesting elements like headings, code, etc
• balanced: no cluttering with overpresent elements or coloring
• aligned: aligned outlines

Used by:

• Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 (images/screenshot.png)
• Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 @ 1 (images/tn.png)

Page URL: Screenshot Link

Creation:

• save as images/screenshot.png
• from original screenshot, scale to 900 x 600 and save as images/tn.png

Remarks:

The locations are mandatory due to Hugo’s theme site builder.

Preview images/screenshot.png:

Preview images/tn.png:

Hero Image

Content:

Show the Demo Screenshot page on different devices and different themes. Composition of the different device screenshots into a template.

The content should be:

• consistent: always use the same page for all devices
• pleasing: use a delightful background

Used by:

• Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640
• GitHub project site: https://github.com/McShelby/hugo-theme-relearn 1280 x 640
• GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/settings 1280 x 640

Page URL: Hero Image Link

Creation:

• Template: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase
• Desktop: light theme 1440 x 900 @ 1
• Tablet: light theme 778 x 1038 @ 1
• Phone: dark theme 450 x 801 @ .666
• From original template resize to 3000 x 1500 offset y: -330, scale to 1280 x 640 and save as images/hero.png

Preview images/hero.png:

Shortcode Feature Images

The feature images for the shortcodes are generated automatically via a Node.js script.

It is located in the repository inside of the /tools directory. All following commands need to be executed from this directory.

To recreate the screenshots

• install Node.js according to their installation guide
• run npm install
• run npm run screenshots