Skip to content

Commit f26880d

Browse files
MarshallOfSoundckerr
authored andcommitted
Update docs on semantic requirements for electron#13359 (electron#13365)
1 parent 91172d6 commit f26880d

File tree

4 files changed

+6
-8
lines changed

4 files changed

+6
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Contributors guide: https://github.com/electron/electron/blob/master/CONTRIBUTIN
1212
- [ ] `npm test` passes
1313
- [ ] tests are [changed or added](https://github.com/electron/electron/blob/master/docs/development/testing.md)
1414
- [ ] relevant documentation is changed or added
15-
- [ ] commit messages or PR title follow semantic [commit guidelines](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines)
15+
- [ ] PR title follows semantic [commit guidelines](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines)

.github/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ newIssueWelcomeComment: |
1212
newPRWelcomeComment: |
1313
💖 Thanks for opening this pull request! 💖
1414
15-
We use [semantic commit messages](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines) to streamline the release process. Before your pull request can be merged, you should **update your pull request title** to start with a semantic prefix, OR prefix at least one of your commit messages.
15+
We use [semantic commit messages](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines) to streamline the release process. Before your pull request can be merged, you should **update your pull request title** to start with a semantic prefix.
1616
1717
Examples of commit messages with semantic prefixes:
1818

docs/development/pull-requests.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,7 @@ A good commit message should describe what changed and why. The Electron project
8686
uses [semantic commit messages](https://conventionalcommits.org/) to streamline
8787
the release process.
8888

89-
Before a pull request can be merged, it should include at least one semantic
90-
commit message, though it's not necessary for all commits in the pull request
91-
to be semantic. Alternatively, you can **update your pull request title** to
92-
start with a semantic prefix.
89+
Before a pull request can be merged, it **must** have a pull request title with a semantic prefix.
9390

9491
Examples of commit messages with semantic prefixes:
9592

@@ -108,6 +105,7 @@ Common prefixes:
108105
- perf: A code change that improves performance
109106
- refactor: A code change that neither fixes a bug nor adds a feature
110107
- style: Changes that do not affect the meaning of the code (linting)
108+
- vendor: Bumping a dependency like libchromiumcontent or node
111109

112110
Other things to keep in mind when writing a commit message:
113111

docs/tutorial/electron-versioning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,12 @@ We reconcile flagged code with our versioning strategy as follows:
136136

137137
We seek to increase clarity at all levels of the update and releases process. Starting with `2.0.0` we will require pull requests adhere to the [Conventional Commits](https://conventionalcommits.org/) spec, which can be summarized as follows:
138138

139-
* Commits that would result in a semver **major** bump must start with `BREAKING CHANGE:`.
139+
* Commits that would result in a semver **major** bump must start their body with `BREAKING CHANGE:`.
140140
* Commits that would result in a semver **minor** bump must start with `feat:`.
141141
* Commits that would result in a semver **patch** bump must start with `fix:`.
142142

143143
* We allow squashing of commits, provided that the squashed message adheres the the above message format.
144-
* It is acceptable for some commits in a pull request to not include a semantic prefix, as long as a later commit in the same pull request contains a meaningful encompassing semantic message.
144+
* It is acceptable for some commits in a pull request to not include a semantic prefix, as long as the pull request title contains a meaningful encompassing semantic message.
145145

146146
# Versionless `master`
147147

0 commit comments

Comments
 (0)