Add .issueflows/04-designs-and-guides/ folder (#26)#44
Merged
jepegit merged 2 commits intoApr 19, 2026
Merged
Conversation
- Introduced a new folder `.issueflows/04-designs-and-guides/` for long-lived design documents, decisions, and good practices. - Updated slash commands (`/iflow`, `/issue-plan`, `/issue-start`, `/issue-close`, `/issue-yolo`) to reference this new folder, encouraging users to consult and document design decisions. - Enhanced the issue-flow rules to include guidance on the new folder's purpose and usage. - Added tests to ensure the folder is created and preserved during initialization and updates, and that commands correctly reference it. This change improves project documentation and consistency in design practices. Closes #26 Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Gives issue-flow projects a durable home for long-lived design docs, design decisions, and agreed good-practices:
.issueflows/04-designs-and-guides/— created byissue-flow init, recreated byissue-flow updateonly when missing, and never overwritten byupdate(the folder is a directory, not aTEMPLATE_MANIFESTentry).Settings.designs_folder = "04-designs-and-guides"threaded throughissueflows_subdirsand the Jinjatemplate_contextas{{ designs_folder }}. Same pattern as the other numbered subdirs — no new env var.issueflow-rules.mdc) now lists the folder in the issue-tracking tree and adds a "Designs and guides" section describing what belongs there and when to read / write it./issue-plan— new step 1.5 "Consult existing designs / guides" plus a Files-to-touch reminder when the plan expects to produce a design doc./issue-start— sub-bullet in step 2 to read relevant designs and record new non-trivial design decisions./issue-close— sanity-check bullet to confirm design decisions are captured before committing./iflowand/issue-yolo— short header notes;/issue-yoloflags that uncovered design decisions usually mean the change is too big for yolo.test_init.pyandtest_config.py, and addedtest_update.pycases that (a) preserve user content inside the folder acrossrun_updateand (b) recreate the folder if it was deleted.Also:
uv version --bump patch.## [Unreleased]inHISTORY.mdto## [0.2.3] - 2026-04-19with a bullet for create a new folder for storing designs and design decissions #26.issue26_original.md/issue26_status.mdinto.issueflows/03-solved-issues/.Left intentionally out of scope (noted in the status file):
docs/cursor-issue-workflow.md.j2and theskills/templates will pick up the same wording in a follow-up.Test plan
uv run pytest— 68 passed.initcreates.issueflows/04-designs-and-guides/.gitkeep; user file inside the folder survivesupdate; deleting the folder then runningupdaterecreates it with.gitkeep.Closes #26.
Made with Cursor