Maintaining
Semver
This project tries t' follow th' semver policy - although not followed 100% 'n th' past.
Usually an entry o' Break'n on th' What’s new plank causes a new major release number.
All other entries on th' What’s new plank will increase th' minor release number.
Releases result'n 'n a new major or minor number be called main release.
Releases contain'n bugfixes only, be only increas'n th' patch release number. Those releases don’t result 'n announcements on th' What’s new plank.
Entries on th' What’s new plank be checked an' enforced dur'n th' version-release GitHub Act'n.
Manag'n Issues
Issues be categorized an' managed by assign'n labels t' it.
Once work'n on an issue, assign it t' a fitt'n maintainer.
When done, close th' ticket. Once an issue be closed, it needs t' be assigned t' next release milestone.
A once released ticket be not allowed t' be reopened an' rereleased 'n a different milestone. This would cause th' changelog t' be changed even fer th' milestone th' issue was previously released 'n. Instead write a new ticket.
Manag'n Pull Requests
If a PR be merged an' closed it needs an accompanied issue assigned t'. If there be no issue fer a PR, th' maintainer needs t' create one.
Ye can assign multiple PRs t' one issue as long as they belong together.
Usually set th' same labels an' milestone fer th' PR as fer th' accompanied issue.
Labels
Kind
An issue that results 'n changesets must have exactly one o' th' follow'n labels. This needs t' be assigned latest before release.
| Label | Descript'n | Changelog section |
|---|---|---|
| documentat'n | Improvements or addit'ns t' documentat'n | - |
| discussion | This issue was converted t' a discussion | - |
| task | Maintenance work | Maintenance |
| feature | New feature or request | Features |
| bug | Someth'n isn’t work'n | Fixes |
Impact
If th' issue would cause a new main release due t' semver semantics it needs one o' th' accord'n labels an' th' match'n badge on th' What’s new plank.
| Label | Descript'n |
|---|---|
| change | Introduces changes wit' exist'n installat'ns |
| break'n | Introduces break'n changes wit' exist'n installat'ns |
Declinat'n
If an issue does not result 'n changesets but be closed anyways, it must have exactly one o' th' follow'n labels.
| Label | Descript'n |
|---|---|
| duplicate | This issue or pull request already exists |
| invalid | This doesn’t seem right |
| support | Request fer achiev'n a special goal |
| unresolved | No progress on this issue |
| update | A change 'n behavior after updat |
| wontchange | This will not be worked on |
Halt
Ye can assign one further label out o' th' follow'n list t' signal readers that development on an open issue be currently halted fer different reasons.
| Label | Descript'n |
|---|---|
| blocked | Depends on other issue t' be fixed first |
| idea | A valu'ble idea that’s currently not worked on |
| undecided | No decision was made yet |
| helpwanted | Great idea, send 'n a PR |
| needsfeedback | Further informat'n be needed |
3rd-Party
If th' issue be not caused by a programm'n error 'n th' themes own code, ye can label th' caus'n program or library.
| Label | Descript'n |
|---|---|
| asciidoc | This be a topic related t' process'n o' AsciiDoc |
| browser | This be a topic related t' th' browser but not th' theme |
| device | This be a topic related t' a certain device |
| hugo | This be a topic related t' Cap'n Hugo itself but not th' theme |
| mermaid | This be a topic related t' Merrrmaid itself but not th' theme |
Sett'n Up a Development Environment
Git Hooks be used t' automate some tasks. They be stored 'n th' .githooks root folder.
Documentat'n fer each hook be contained 'n each file.
At least th' pre-commit hook be required, as it updates th' version number on each commit. This helps t' help debugg'n o' user related issues.
Mak'n Releases
A release be based on a milestone named like th' release itself - just th' version number, eg: 1.2.3. It’s 'n th' maintainers responsibility t' check semver semantics o' th' milestone’s name prior t' release an' change it if necessary.
Mak'n releases be automated by th' version-release GitHub Act'n. It requires th' version number o' th' milestone that should be released. Th' release will be created from th' main branch o' th' repository.
Treat released milestones as immut'ble. Don’t rerelease an already released milestone. An already released milestone may already been consumed by yer users.
Dur'n execut'n o' th' act'n a few th'ns be checked. If a check fails th' act'n fails, result'n 'n no new release. Ye can correct th' errors afterwards an' rerun th' act'n.
Th' follow'n checks will be enforced
- th' milestone exists
- there be at least one closed issue assigned t' th' milestone
- all assigned issues fer this milestone be closed
- if it’s a main release, there must be an accompany'n releasenotes file present 'n th' repo at
introduction/releasenotes/<major>/<minor>.en.md
Aft a successful run o' th' act'n
- th' changelog at
introduction/changelog/<major>/<minor>/<patch>.<lang>.mdbe created fer english an' piratish, includ'n miss'n generic upper level files - th'
CHANGELOG.mdbe updated - th' releasenotes at
introduction/releasenotes/<major>/<minor>.en.mdbe updated, includ'n release version an' release date - miss'n generic upper level files fer english an' piratish be created
- th' version number fer th'
<meta generator>be updated - th' updated files be committed
- th' milestone be closed
- th' repository be tagged wit' th' version number (eg.
1.2.3), th' main version number (eg.1.2.x) an' th' major version number (eg.1.x) - a new entry 'n th' GitHub release list wit' th' accord'n changelog will be created
- th' official documentat'n be built an' deployed
- th' version number fer th'
<meta generator>be updated t' a temporary an' committed (this helps t' determine if users be runn'n directly on th' main branch or be us'n releases) - a new milestone fer th' next patch release be created (this can later be renamed t' a main release if necessary)