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

docs: add versioning policy, changelog, and update contributing guide #149

Merged
shoko merged 2 commits from fix/issue-120 into main 2026-04-05 12:44:44 +02:00
Conversation 3 Commits 2 Files Changed 3 +229 -4
shoko commented 2026-04-05 11:38:43 +02:00
Owner
Copy Link

Summary

Addresses issue #120 - Foundation work for documentation.

Changes

  1. VERSIONING.md (new) - Documents versioning policy:

    • Branch strategy: main (0.1.x stable), develop (0.2.x experimental)
    • Version format: MAJOR.MINOR.PATCH
    • Deprecation policy
    • Backward compatibility principles

  2. docs/CHANGELOG.md (new) - Release notes:

    • Tracks v0.1.0 through v0.2.1
    • Based on git history and tags

  3. CONTRIBUTING.md (updated):

    • Fixed master -> main references
    • Added develop branch documentation
    • Added feature branch prefixes (fix/, feat/, docs/, refactor/)
    • Added backport compatibility guidelines

Acceptance Criteria

  • VERSIONING.md explains 0.1.x vs 0.2.x strategy clearly
  • CHANGELOG.md tracks all releases (v0.1.x tags)
  • CONTRIBUTING.md reflects current branch model

Fixes #120

## Summary Addresses issue #120 - Foundation work for documentation. ### Changes 1. **VERSIONING.md** (new) - Documents versioning policy: - Branch strategy: `main` (0.1.x stable), `develop` (0.2.x experimental) - Version format: MAJOR.MINOR.PATCH - Deprecation policy - Backward compatibility principles 2. **docs/CHANGELOG.md** (new) - Release notes: - Tracks v0.1.0 through v0.2.1 - Based on git history and tags 3. **CONTRIBUTING.md** (updated): - Fixed `master` -> `main` references - Added `develop` branch documentation - Added feature branch prefixes (fix/*, feat/*, docs/*, refactor/*) - Added backport compatibility guidelines ## Acceptance Criteria - [x] VERSIONING.md explains 0.1.x vs 0.2.x strategy clearly - [x] CHANGELOG.md tracks all releases (v0.1.x tags) - [x] CONTRIBUTING.md reflects current branch model Fixes #120
shoko added 1 commit 2026-04-05 11:38:43 +02:00
docs: add versioning policy, changelog, and update contributing guide 16e417c88e 
- Add VERSIONING.md documenting 0.1.x/0.2.x branch strategy
- Add docs/CHANGELOG.md with release notes for v0.1.0-v0.2.1
- Update CONTRIBUTING.md: fix master->main, add develop branch
- Closes #120
han reviewed 2026-04-05 11:54:35 +02:00
CONTRIBUTING.md Outdated
@@ -3,3 +3,3 @@
## Workflow
1. Create a branch for your work: `git checkout -b fix/issue-N-name` or `git checkout -b docs/topic-name`
1. Create a branch for your work: `git checkout -b fix/issue-N-name` or `git checkout -b feat/feature-name`
han commented 2026-04-05 11:54:35 +02:00
First-time contributor
Copy Link

the branch name should be fix/issue-N-bug-name or feat/issue-N-feature-name

the branch name should be fix/issue-N-bug-name or feat/issue-N-feature-name
han requested changes 2026-04-05 11:56:15 +02:00
Dismissed
han left a comment
First-time contributor
Copy Link

added a minor adjustment request

added a minor adjustment request
shoko added 1 commit 2026-04-05 12:27:01 +02:00
fix CONTRIBUTING.md: branch naming should include issue number 92f8369d6f 
Address han's review feedback:
- Changed feat/feature-name to feat/issue-N-feature-name
- Consistent with fix/issue-N-name format
han approved these changes 2026-04-05 12:41:52 +02:00
han left a comment
First-time contributor
Copy Link

lgtm

lgtm
shoko merged commit fb9cc72f44 into main 2026-04-05 12:44:44 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
han
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
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
shoko
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: shoko/kugetsu#149
Delete Branch "fix/issue-120"

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?