patrick91 / patrick91/shortcake
Add `sc create --closes` support for issue-closing PR metadata
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- Avg merge
- 4h 22m
- Merged PRs (30d)
- 5
Description
Goal
Allow a branch/PR to declare issues it closes, e.g.
sc create --closes 1212
Then sc submit should include the appropriate GitHub closing keyword in the PR body so merging the PR closes the referenced issue.
Open design questions
- Should
--closessupport multiple issue numbers? - Should the data live in a
Shortcake-*trailer, another durable branch marker, or only in generated PR body content? - How should this interact with existing stack description regeneration on
sc submit? - Should
sc create --closes owner/repo#123be supported for cross-repo issues?
Acceptance criteria
sc create --closes <issue>persists the closing reference durably enough for latersc submit.sc submitadds closing keywords to created/updated PR descriptions without losing the stack map.- Existing PR body sync remains idempotent.
- Tests cover single and multiple issue references.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the sc create and sc submit command entry points, then trace the existing stack description and PR body synchronization behavior. Review the existing tests for PR body sync and add coverage for durable single and multiple issue references, preserving the stack map and idempotence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100