Skip to content

Commit fdb7dfb

Browse files
authored
docs: update commit message (#7570)
* add issue bot for prs * Update CHANGELOG.md * Update issue-bot.yml * Update CONTRIBUTING.md
1 parent 16e9a6f commit fdb7dfb

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CONTRIBUTING.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,11 @@ The _type_ is the category of change that is made, possible types are:
309309
- `ci` - continuous integration
310310
- `test` - tests
311311

312-
The _summary_ is a short change description in present tense, not capitalized, without period at the end.
312+
The _summary_ is a short change description in present tense, not capitalized, without period at the end. This summary will also be used as the changelog entry.
313+
- It must be short and self-explanatory for a reader who does not see the details of the full pull request description
314+
- It must not contain abbreviations, e.g. instead of `LQ` write `LiveQuery`
315+
- It must use the correct product and feature names as referenced in the documentation, e.g. instead of `Cloud Validator` use `Cloud Function validation`
316+
- In case of a breaking change, the summary must not contain duplicate information that is also in the [BREAKING CHANGE](#breaking-change) chapter of the pull request description. It must not contain a note that it is a breaking change, as this will be automatically flagged as such if the pull request description contains the BREAKING CHANGE chapter.
313317

314318
For example:
315319

@@ -321,11 +325,15 @@ Currently, we are not making use of the commit _scope_, which would be written a
321325

322326
### Breaking Change
323327

324-
If a pull request contains a braking change, the text of the pull request must contain the word `BREAKING CHANGE` capitalized as the _last, most bottom_ part of the text. It must be followed by an empty line, then a short description of the character of the breaking change, and ideally how the developer should address it.
328+
If a pull request contains a braking change, the description of the pull request must contain a special chapter at the bottom.
329+
330+
The chapter consists of the phrase `BREAKING CHANGE`, capitalized, in a single line without any formatting. It must be followed by an empty line, then a short description of the breaking change, and ideally how the developer should address it. This chapter should contain more details focusing on the "breaking” aspect of the change, as it is intended to assist the developer in adapting their deployment. However, keep it concise, as it will also become part of the changelog entry.
325331
326332
For example:
327333
328334
```
335+
Detailed pull request description...
336+
329337
BREAKING CHANGE
330338
331339
The door handle has be pulled up to open the door, not down. Adjust your habits accordingly by walking on your hands.

0 commit comments

Comments
 (0)