mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Update docs on semantic requirements for #13359 (#13365)

Browse source
This commit is contained in:
Samuel Attard 2018-07-19 01:41:58 +10:00 • committed by Charles Kerr
parent 91172d6387
commit f26880db03
4 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/development/pull-requests.md
View file

@ -86,10 +86,7 @@ A good commit message should describe what changed and why. The Electron project
uses [semantic commit messages](https://conventionalcommits.org/) to streamline
the release process.
Before a pull request can be merged, it should include at least one semantic
commit message, though it's not necessary for all commits in the pull request
to be semantic. Alternatively, you can **update your pull request title** to
start with a semantic prefix.
Before a pull request can be merged, it **must** have a pull request title with a semantic prefix.
Examples of commit messages with semantic prefixes:
@ -108,6 +105,7 @@ Common prefixes:
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (linting)
- vendor: Bumping a dependency like libchromiumcontent or node
Other things to keep in mind when writing a commit message: