Contributing
Code Quality
A new release can happen at any time from th' main branch o' th' GitHub project without further acknowledgment. This makes it necessary that, every pushed set o' changesets into th' main branch must be self-contained an' correct, result'n 'n a releas'ble version.
Stay simple fer th' user by focus'n on th' mantra “convent'n over configuration”.
At installat'n th' ship should work reason'ble without (m)any configurat'n.
Stay close t' th' Cap'n Hugo way.
Don’t use npm or any preprocess'n, our contributors may not be front-end developers.
Document new features 'n th' docs. This also contains entries t' th' What’s new plank.
Don’t break exist'n features if ye don’t have t'.
Remove reported issue from th' browser’s console.
Check fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.
Conventional Commits
Write commit messages 'n th' conventional commit format: a type, th' affected part o' th' theme as scope 'n parentheses an' a short descript'n, followed by th' number o' th' related issue.
Th' scope be never left out. Release commits be th' only except'n; th' release workflow writes them as Release <version>.
Th' type tells what kind o' change it be. Ask th' quest'ns 'n order; th' first one ye answer wit' yes gives th' type.
| Quest'n | If Yes → Type |
|---|---|
| Reverts a previous commit? | revert |
| Bug fix (incl. security dependency patches)? | fix |
| New, changed, or removed behavior 'n API/UI? | feat |
| Performance improvement? | perf |
| Code restructur'n without behavior change? | refactor |
| Deployment, infrastructure, or backups? | ops |
| CI pipeline config only? | ci |
| Build tool'n, dependencies, versions? | build |
| Tests only? | test |
| Documentat'n only? | docs |
| Code formatt'n only (not CSS)? | style |
| Anyth'n else | chore |
| Breaks exist'n consumers? | add ! t' any type |
Follow'n be an incomplete list o' some o' th' used scopes. Be creative.
| Common | Feature | Structure | Shorrrtcodes |
|---|---|---|---|
| browser | a11y | favicon | attachments |
| shorrrtcodes | archetypes | search | badge |
| theme | alias | menu | button |
| generator | history | callout | |
| i18n | scrollbar | children | |
| mobile | nav | details | |
| toc | ay'con | ||
| rss | clipboard | include | |
| variant | syntaxhighlight | math | |
| boxes | mermaid | ||
| table | openapi | ||
| piratify | |||
| siteparam | |||
| tabs |
Issue titles be not written 'n th' conventional commit format. They start wit' th' affected part, like table: make columns sortable or docs: write commit messages wit' type an' scope.