https://ohcnwiki.tellmey.fyi/index.php?action=history&feed=atom&title=Contributing%2FPlugin_development_cycleContributing/Plugin development cycle - Revision history2026-07-09T14:01:01ZRevision history for this page on the wikiMediaWiki 1.45.4https://ohcnwiki.tellmey.fyi/index.php?title=Contributing/Plugin_development_cycle&diff=595&oldid=prevAdmin: Create Plugin development cycle guide (via create-page on MediaWiki MCP Server)2026-07-09T10:05:47Z<p>Create Plugin development cycle guide (via create-page on MediaWiki MCP Server)</p>
<p><b>New page</b></p><div>{{Doc header<br />
|type=guide<br />
|domain=contributing<br />
|title=Plugin development cycle<br />
|order=4<br />
}}<br />
<br />
All CARE plugins follow a '''shared development cycle''' to keep the ecosystem predictable and reviewable. Every plugin repository must use the <code>develop</code> branch as its integration branch.<br />
<br />
== Branching model ==<br />
<br />
<pre><br />
main ─────── (tagged releases only)<br />
╱<br />
develop ───────────── (integration branch)<br />
╱ │ ╲<br />
feature/foo ─ │ ─── feature/bar<br />
│<br />
fix/bug-123 ───<br />
</pre><br />
<br />
; <code>main</code> : Tagged releases only. Merged from <code>develop</code> when cutting a release.<br />
; <code>develop</code> : Default integration branch. '''All''' features and fixes merge here after review. Must exist in every plugin repo.<br />
; <code>feature/&lt;name&gt;</code> : Branch off <code>develop</code> for new features.<br />
; <code>fix/&lt;description&gt;</code> : Branch off <code>develop</code> for bug fixes.<br />
; <code>chore/&lt;description&gt;</code> : Branch off <code>develop</code> for maintenance tasks.<br />
<br />
== Creating the develop branch ==<br />
<br />
If a plugin repository does not yet have a <code>develop</code> branch, create it from the current state of <code>main</code>:<br />
<br />
<syntaxhighlight lang="bash">git checkout main<br />
git pull origin main<br />
git checkout -b develop<br />
git push origin develop<br />
</syntaxhighlight><br />
<br />
Then set <code>develop</code> as the default branch in the repository settings on GitHub (Settings → Branches → Default branch).<br />
<br />
== Workflow ==<br />
<br />
# '''Branch''': Create a feature/fix/chore branch from <code>develop</code>.<br />
# '''Build''': Implement your changes on that branch.<br />
# '''Review''': Open a Pull Request targeting <code>develop</code>.<br />
# '''Merge''': After approval, squash-merge into <code>develop</code>.<br />
# '''Release''': When ready, merge <code>develop</code> into <code>main</code> and tag the release.<br />
<br />
== Commit conventions ==<br />
<br />
Use semantic commit prefixes for changelog generation:<br />
<br />
; <code>feat:</code> : A new feature<br />
; <code>fix:</code> : A bug fix<br />
; <code>chore:</code> : Maintenance or tooling<br />
; <code>docs:</code> : Documentation changes<br />
; <code>refactor:</code> : Code restructuring<br />
; <code>test:</code> : Adding or fixing tests<br />
; <code>perf:</code> : Performance improvements<br />
<br />
Example: <code>feat: add discharge summary endpoint</code><br />
<br />
== Review requirements ==<br />
<br />
- At least '''one approval''' from a maintainer before merging.<br />
- All CI checks must pass.<br />
- The branch must be up to date with <code>develop</code> (rebased or merged).<br />
<br />
== Plugin lifecycle ==<br />
<br />
; Experimental : New plugin in active development. May break between commits.<br />
; Stable : Ready for production use. Follows the full development cycle.<br />
; Deprecated : Replaced or superseded. No active development.<br />
<br />
{{Navbox contributing}}<br />
<br />
{{Related}}</div>Admin