Skip to content

Add .issueflows/04-designs-and-guides/ folder (#26)#44

Merged
jepegit merged 2 commits into
mainfrom
26-create-a-new-folder-for-storing-designs-and-design-decissions
Apr 19, 2026
Merged

Add .issueflows/04-designs-and-guides/ folder (#26)#44
jepegit merged 2 commits into
mainfrom
26-create-a-new-folder-for-storing-designs-and-design-decissions

Conversation

@jepegit
Copy link
Copy Markdown
Owner

@jepegit jepegit commented Apr 19, 2026

Summary

Gives issue-flow projects a durable home for long-lived design docs, design decisions, and agreed good-practices:

  • New folder .issueflows/04-designs-and-guides/ — created by issue-flow init, recreated by issue-flow update only when missing, and never overwritten by update (the folder is a directory, not a TEMPLATE_MANIFEST entry).
  • Config plumbing. Settings.designs_folder = "04-designs-and-guides" threaded through issueflows_subdirs and the Jinja template_context as {{ designs_folder }}. Same pattern as the other numbered subdirs — no new env var.
  • Rule file (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.
  • Slash commands reference the folder:
    • /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.
    • /iflow and /issue-yolo — short header notes; /issue-yolo flags that uncovered design decisions usually mean the change is too big for yolo.
  • Tests. Extended test_init.py and test_config.py, and added test_update.py cases that (a) preserve user content inside the folder across run_update and (b) recreate the folder if it was deleted.

Also:

Left intentionally out of scope (noted in the status file): docs/cursor-issue-workflow.md.j2 and the skills/ templates will pick up the same wording in a follow-up.

Test plan

  • uv run pytest — 68 passed.
  • Manual scratch-dir walkthrough: init creates .issueflows/04-designs-and-guides/.gitkeep; user file inside the folder survives update; deleting the folder then running update recreates it with .gitkeep.

Closes #26.

Made with Cursor

jepegit added 2 commits April 19, 2026 22:50
- 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
- Bump version to 0.2.3 (patch) via uv version --bump patch.
- Promote HISTORY.md [Unreleased] -> [0.2.3] - 2026-04-19 and record the
  new bullet for #26.
- Archive issue26_* into 03-solved-issues/.

Refs #26.

Made-with: Cursor
@jepegit jepegit linked an issue Apr 19, 2026 that may be closed by this pull request
@jepegit jepegit merged commit 5080e76 into main Apr 19, 2026
1 check passed
@jepegit jepegit deleted the 26-create-a-new-folder-for-storing-designs-and-design-decissions branch April 19, 2026 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

create a new folder for storing designs and design decissions

1 participant