• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ChangeLog
2## *Example* Subsystem (Do not modify or delete this example)
3Changes that affect contract compatibility of a released version should be described in the ChangeLog. The changes include but are not limited to those related to API names, parameters, return values, required permissions, call sequence, enumerated values, configuration parameters, and paths. Contract compatibility, also called semantic compatibility, means that the original program behavior should remain consistent over versions.
4### cl.subsystemname.x xxx Function Change (Example: DeviceType Attribute Change or Camera Permission Change. Use a short description.)
5Add the number **cl.*subsystemname*.*x*** before each change title, where **cl** is the abbreviation of ChangeLog, *subsystemname* is the standard English name of the subsystem, and *x* indicates the change sequence number (in ascending order).
6Describe the changes in terms of functions. Example: *n* and *m* of the *a* function are changed. Developers need to adapt their applications based on the change description.
7If there is a requirement or design document corresponding to the change, attach the requirement number or design document number in the description.
8
9**Change Impact**
10
11Describe whether released APIs (JS, Java, or native APIs) are affected or API behavior is changed.
12
13**Key API/Component Changes**
14
15List the API/component changes involved in the function change.
16
17**Adaptation Guide (Optional)**
18
19Provide guidance for developers on how to adapt their application to the changes to be compatible with the new version. Example:
20Change parameter *n* to *m* in the *a* file.
21```
22sample code
23```
24### cl.subsystemname.x xxx Function Change
25If a subsystem introduces any function changes, include a standalone section in the subsystem chapter to describe the function changes.
26
27## *Example* Subsystem
28Each subsystem has only one such chapter.
29