diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md new file mode 100644 index 0000000..f8409d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -0,0 +1,26 @@ +--- +name: Release checklist +about: Track stable release readiness +title: "release: vX.Y.Z" +labels: ["release"] +assignees: [] +--- + +## Pre-release validation + +- [ ] Node import/startup passes on clean ComfyUI +- [ ] Core workflows smoke-tested +- [ ] `third_party/forks_manifest.yaml` reviewed/updated +- [ ] `CHANGELOG.md` updated +- [ ] Release notes drafted (`docs/RELEASE_NOTES_TEMPLATE.md`) + +## Publish + +- [ ] Create annotated tag (`vX.Y.Z`) +- [ ] Push tag +- [ ] Publish GitHub release with notes + +## Post-release + +- [ ] Announce stable version to users +- [ ] Track regressions/bug reports diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..603126f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ +## Summary + +Describe what this PR changes and why. + +## Type of change + +- [ ] Docs +- [ ] Refactor +- [ ] Feature +- [ ] Fix +- [ ] Breaking change + +## Checklist + +- [ ] I updated docs (if needed) +- [ ] I updated `CHANGELOG.md` (if needed) +- [ ] I tested node loading in ComfyUI +- [ ] I documented third-party derivations/changes in `third_party/` +- [ ] I verified no secrets/tokens are included + +## Testing Notes + +- ComfyUI version tested: +- Platform tested: +- Result: + +## Screenshots / Workflow evidence (optional) + +Attach screenshots or a workflow JSON reference if helpful. diff --git a/CHANGELOG.md b/CHANGELOG.md index 541f4ab..42dcf5b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,10 @@ The format is inspired by Keep a Changelog and SemVer. - `third_party/THIRD_PARTY.md` - `third_party/forks_manifest.yaml` - `tools/report_mods.py` +- Contribution/release templates: + - `.github/PULL_REQUEST_TEMPLATE.md` + - `.github/ISSUE_TEMPLATE/release_checklist.md` + - `docs/RELEASE_NOTES_TEMPLATE.md` ## [0.1.0] - 2026-02-14 diff --git a/docs/RELEASE_NOTES_TEMPLATE.md b/docs/RELEASE_NOTES_TEMPLATE.md new file mode 100644 index 0000000..52cb585 --- /dev/null +++ b/docs/RELEASE_NOTES_TEMPLATE.md @@ -0,0 +1,52 @@ +# Release Notes Template + +Use this template when publishing a GitHub Release for a stable tag. + +## Title + +`vX.Y.Z` + +## Summary + +One short paragraph explaining what changed and why users should upgrade. + +## ✅ Tested Matrix + +- ComfyUI commit/tag: +- Python version: +- CUDA version: +- GPU(s): +- OS: + +## Added + +- + +## Changed + +- + +## Fixed + +- + +## Breaking Changes + +- None / list here + +## Known Issues + +- + +## Upgrade Notes + +- Any migration steps for users +- Any node behavior changes to watch for + +## Install + +Production recommendation: install by tag/commit, not moving branch heads. + +```bash +git clone --branch vX.Y.Z https://github.com/malkuthro/ComfyUI-Koolook.git +``` diff --git a/docs/RELEASE_WORKFLOW.md b/docs/RELEASE_WORKFLOW.md index a0e30d5..fa09bca 100644 --- a/docs/RELEASE_WORKFLOW.md +++ b/docs/RELEASE_WORKFLOW.md @@ -31,6 +31,7 @@ git push origin vX.Y.Z ``` 5. Publish GitHub release notes (what changed, tested matrix, known issues) + - use `docs/RELEASE_NOTES_TEMPLATE.md` ## Production Install Recommendation diff --git a/third_party/forks_manifest.yaml b/third_party/forks_manifest.yaml index f73ca9a..1f01071 100644 --- a/third_party/forks_manifest.yaml +++ b/third_party/forks_manifest.yaml @@ -8,6 +8,7 @@ entries: local_paths: - "k_easy_resize.py" status: "modified" + sync_state: "needs-upstream-reference" license: "unknown" notes: "Inspired by Resize Image V2; verify exact upstream commit/license metadata." @@ -17,5 +18,18 @@ entries: source_ref: "n/a" local_paths: [] status: "reference_only" + sync_state: "n/a" license: "unknown" notes: "No vendored code; integration reference in docs/workflows." + + - id: "wan22_parameter_reference" + name: "Wan 2.2 parameter docs reference" + source_repo: "https://alidocs.dingtalk.com/i/nodes/EpGBa2Lm8aZxe5myC99MelA2WgN7R35y" + source_ref: "n/a" + local_paths: + - "config.json" + - "k_easy_wan22_prompt.py" + status: "reference_only" + sync_state: "manual" + license: "unknown" + notes: "Prompt parameter taxonomy inspired by external docs; no direct vendored code tracked yet."