Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
summarize semantic commit requirements #12665
This PR represents a first step toward a "conventional commits" requirement on electron/electron.
Rather than requiring every single commit message to follow a convention, the approach here is to require at least one semantic commit message in the PR, or a semantic PR title.
We've been using the https://github.com/apps/semantic-pull-request probot app on electron/i18n for a few weeks, and it's worked well. If a PR is ready to go but doesn't yet meet the semantic requirements, a maintainer can change the PR title to get checks passing, then merge.
Yessss. Definitely want to have this documented so we can link to it as needed, especially because the message here only applies to first-timers, not the hundreds of people who have already landed PRs on electron.
Started a TODO list up top
I like new examples in the present tense much more than the old ones in the past tense.
- The first line should:
- contain a short description of the change (preferably 50 characters or less,
and no more than 72 characters)
- Wrap all other lines at 72 columns.
Are we going to drop line width requirement?
I guess a lot of people work with git in a console, and long commit messages just create a mess.
So I think the requirement should be kept and probably even enforced by a pre-commit hooks and CI checks (bots can work too).