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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-2
Original file line number
Diff line number
Diff line change
@@ -309,7 +309,11 @@ The _type_ is the category of change that is made, possible types are:
309
309
-`ci`- continuous integration
310
310
-`test`- tests
311
311
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. insteadof`LQ` write `LiveQuery`
315
+
- It must use the correct product and feature names as referenced in the documentation, e.g. insteadof`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 [BREAKINGCHANGE](#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 BREAKINGCHANGE chapter.
313
317
314
318
For example:
315
319
@@ -321,11 +325,15 @@ Currently, we are not making use of the commit _scope_, which would be written a
321
325
322
326
### Breaking Change
323
327
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.
325
331
326
332
For example:
327
333
328
334
```
335
+
Detailed pull request description...
336
+
329
337
BREAKING CHANGE
330
338
331
339
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