improve committing changes skill - #159
Conversation
Plugin Validation Summary —
|
SaintPatrck
left a comment
There was a problem hiding this comment.
@quexten we spoke briefly in Slack about these changes possibly not being needed now that we have Stacked PR's enabled. Are you still interested in exploring this, or should it be closed for now?
❓ Is bitwarden/sdk-internal@406cfdc meant to be an example of a good or bad commit?
| ## Structure Commits by Intent | ||
|
|
||
| Changes should be structured by intent. If there is more than one intent in the working directory / staged, break down the changes into a set of commits — one intent per commit (a refactor, a new helper, a feature, a bugfix, a test addition, a rename), each independently reviewable. | ||
|
|
||
| --- | ||
|
|
||
| ## Follow-up Fixes on an Open PR | ||
|
|
||
| When committing a follow-up fix on a PR that is not yet merged, consider doing a rebase so that the single intent commit that introduced this change gets replaced, rather than stacking a separate "fix" commit on top. This keeps history structured by intent (see above): the branch reads as one clean commit per intent instead of a change plus a trail of corrections. | ||
|
|
||
| --- |
There was a problem hiding this comment.
💭 I feel like restructuring-git-history warrants its own skill that can be triggered by users when/if they want to cleanup their work history. That skill would reference committing-changes to format a specific commit correctly. As a separate skill, it also becomes flexible enough to incorporate into other things like this "Storybook" concept I was experimenting with to improve the code review experience.
It's also important to consider the description and expected triggers for this skill. They're intentionally broad enough to trigger on any allusion to committing changes which increases chances of unintentionally and silently rewriting someone's history.
| Users reported confusion about when biometric prompts appear. | ||
| This adds a configurable timeout setting to the security preferences. | ||
|
|
||
| Jira-Ticket: PM-12345 |
There was a problem hiding this comment.
🎟️ Tracking
📔 Objective
Currently, the committing changes skill may result in hard to review changesets. We want the change sets to be easily reviewable. To do this, they have to be structured by intent, with one intent captured per commit. This makes PR's easy to review commit-by-commit instead of as one big diff.
Example: bitwarden/sdk-internal@406cfdc