Conversation
Contributor
Author
|
@peircej just adding you to review to confirm that this lines up with what you're thinking for the new commit spec |
peircej
requested changes
Sep 18, 2026
peircej
left a comment
peircej
left a comment
Member
There was a problem hiding this comment.
Looks good, subject to a couple of minor changes.
I think we should add:
- breaking changes MUST contain a BREAKING CHANGE: footer and optionally the !feat. The use of the footer seems good in that the commit introduces one feature (that's in the title) but the side effect is described in the footer
- possibly we also mention the use of
(scope)to specify the area that this fixed likefix(app)orfix(lib). One suggestion elsewhere is to use a specific scope ofregto indicate fixing regressions (of unreleased changes). We could use that without the others even
| * *chore*: Changes to processes, actions, etc. (devops stuff, basically) | ||
|
|
||
| .. note:: | ||
| PsychoPy only recently (2026) moved over to Common Commits, so you may be familiar with our old commit message style. If you are, here is how the old tags correspond to the new ones: |
Member
There was a problem hiding this comment.
typo - Conventional Commits not Common Commits
Contributor
Author
There was a problem hiding this comment.
So fix(reg) would be equivalent to the old FF tag? I'd be happy with that.
Contributor
Author
There was a problem hiding this comment.
I think I prefer ! for breaking changes as it means not having to look at the commit footers when compiling release notes (the script I've got just looks at the PR title), but I'm up for supporting both.
This branch has not been deployed
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
2 participants
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.
No description provided.