shoko/kugetsu
1
0
Fork 0
Code Issues 17 Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Foundation - Documentation #120

New Issue
Closed
opened 2026-04-03 11:14:06 +02:00 by shoko · 0 comments
shoko commented 2026-04-03 11:14:06 +02:00
Owner
Copy Link

Summary

Create/update documentation for versioning policy and project structure.

Details

Create/update:

  • VERSIONING.md at root - branch model, deprecation policy, version rules
  • docs/CHANGELOG.md - release notes per version
  • CONTRIBUTING.md - fix master to main, document main/develop branch model

VERSIONING.md Content

Should document:

  • Branch strategy: main (0.1.x stable), develop (0.2.x experimental)
  • Version format: MAJOR.MINOR.PATCH
  • Deprecation policy: deprecated in minor X, removed in major X+1
  • Backward compatibility principle: adding inputs is ok, changing behavior requires deprecation
  • What constitutes backport-compatible vs 0.2.x-only changes

Backport Compatible

Documentation only.

Acceptance Criteria

  • VERSIONING.md explains 0.1.x vs 0.2.x strategy clearly
  • CHANGELOG.md tracks all releases (start with existing v0.1.x tags)
  • CONTRIBUTING.md reflects current branch model
## Summary Create/update documentation for versioning policy and project structure. ## Details Create/update: - `VERSIONING.md` at root - branch model, deprecation policy, version rules - `docs/CHANGELOG.md` - release notes per version - `CONTRIBUTING.md` - fix `master` to `main`, document `main`/`develop` branch model ## VERSIONING.md Content Should document: - Branch strategy: `main` (0.1.x stable), `develop` (0.2.x experimental) - Version format: MAJOR.MINOR.PATCH - Deprecation policy: deprecated in minor X, removed in major X+1 - Backward compatibility principle: adding inputs is ok, changing behavior requires deprecation - What constitutes backport-compatible vs 0.2.x-only changes ## Backport Compatible Documentation only. ## Acceptance Criteria - [ ] VERSIONING.md explains 0.1.x vs 0.2.x strategy clearly - [ ] CHANGELOG.md tracks all releases (start with existing v0.1.x tags) - [ ] CONTRIBUTING.md reflects current branch model
shoko added the backportfoundation labels 2026-04-03 11:18:18 +02:00
shoko added this to the v0.2.x milestone 2026-04-03 11:18:18 +02:00
shoko closed this issue 2026-04-05 12:44:44 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
0.2.x-only
Available only in 0.2.x, not backportable
 0.3.x-only
Available only in 0.3.x, not backportable
 backport
Backport compatible - can merge to 0.1.x
 blocked
Issue needs clarification/discussion before it can be worked on
 bug
Bug report
 critical
Critical - blocking parallel work
 feature
New feature
 foundation
Foundation work for 0.2.x
 high
High priority - workflow improvements
 meta
Meta issue tracking multiple issues
 need-review
PR needs review before merge
 parallelization
Issues related to parallelization
 ready
Issue is clear and ready to be implemented/delegated
 ready-to-merge
PR approved and ready to merge
 task-delegation
Issues related to task-delegation
No Label backport foundation
Milestone
No items
No Milestone v0.2.x
Projects
Clear projects
No project
Assignees
Clear assignees
shoko
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: shoko/kugetsu#120
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?