You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 9, 2018. It is now read-only.
Repository navigation
This repository was archived by the owner on Jul 9, 2018. It is now read-only.
Conventional Commits can be fully customized, a common implementation of this seen in widespread use thoughout GitHub is Angular implementation, prefixing commits with docs:, fix:, ci:, chore: and so on, when working with scoped packages the format takes on the package name as the scope, e.g. docs(i18n):, docs(a11y):, docs(is-shallow-equal): etc
Even though the Angular format above is quite common Conventional Commits is fully customizable and there are a numerous configurations available to be used from projects such as ESLint, Atom, jQuery to name but a few.
One of particular note is the jQuery preset where commits should look like:
Component: Short Description
Optional Long Description
Fixes #xxx
Closes gh-yyy
Ref #zzz
This matches quite closely the WordPress commit message format documented in our handbook:
Component: Brief summary.
Longer description with more details, such as a `new_hook` being introduced with the context of a `$post` and a `$screen`.
More paragraphs can be added as needed.
Props person, another.
Fixes #30000. See #20202, #105.
By mixing the scope package names with our own WordPress Conventional Commit Preset we could have our CHANGELOG.md files generated using a format common to existing WordPress processes which would be benfecial if the packages repo is to get merged into SVN.
Like I said int he #core-js meeting this week, I think this ties into @pento's proposal to only use squash commits when merging PRs on WordPress GitHub repositories. The squash pull request merge UI allows one to change the title and message of the squash commit:
That would remove the burden on new contributors completely. All maintainers would then make sure that this format is followed on the packages repository.
This should also be codified in CONTRIBUTING.md. Also mention of when CHANGELOG.md edits should be made (as part of proposed changes, or prior to release).
Activity
atimmer commentedon May 1, 2018
Like I said int he #core-js meeting this week, I think this ties into @pento's proposal to only use squash commits when merging PRs on WordPress GitHub repositories. The squash pull request merge UI allows one to change the title and message of the squash commit:
That would remove the burden on new contributors completely. All maintainers would then make sure that this format is followed on the packages repository.
ntwb commentedon May 8, 2018
Instead of hacking on changelogs here in this repo, I've just created https://github.com/ntwb/lerna-playground to work on implementing a "Conventional Commits Specification".
If you'd like access to push, pull, and hack on that repo please ping me here or in Slack and I'll add you.
gziolo commentedon May 10, 2018
I would be happy to see something like this helping with changelog files. 👍
aduth commentedon May 23, 2018
This should also be codified in
CONTRIBUTING.md. Also mention of whenCHANGELOG.mdedits should be made (as part of proposed changes, or prior to release).Related discussion: https://github.com/WordPress/packages/pull/128/files#r190238611
ntwb commentedon Jul 9, 2018
Issue moved to WordPress/gutenberg #7800 via ZenHub