1e41f4b71Sopenharmony_ci# *Example* Subsystem ChangeLog
2e41f4b71Sopenharmony_ci
3e41f4b71Sopenharmony_ciChanges that affect contract compatibility of the last 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. The last version can be an LTS, release, beta, or monthly version, or the like. Contract compatibility, also called semantic compatibility, means that the original program behavior should remain consistent over versions.
4e41f4b71Sopenharmony_ci
5e41f4b71Sopenharmony_ci## cl.subsystemname.x xxx Function Change (Example: DeviceType Attribute Change or Camera Permission Change. Use a short description.)
6e41f4b71Sopenharmony_ci
7e41f4b71Sopenharmony_ciAdd 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 (starting from 1 in ascending order).
8e41f4b71Sopenharmony_ci
9e41f4b71Sopenharmony_ciDescribe 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.
10e41f4b71Sopenharmony_ci
11e41f4b71Sopenharmony_ciIf there is a requirement or design document corresponding to the change, attach the requirement number or design document number in the description.
12e41f4b71Sopenharmony_ci
13e41f4b71Sopenharmony_ci**Change Impacts**
14e41f4b71Sopenharmony_ci
15e41f4b71Sopenharmony_ciDescribe whether released APIs (JS or native APIs) are affected or API behavior is changed.
16e41f4b71Sopenharmony_ci
17e41f4b71Sopenharmony_ciDescribe whether available applications are affected, that is, whether an adaptation is required for building the application code in the SDK environment of the new version.
18e41f4b71Sopenharmony_ci
19e41f4b71Sopenharmony_ci**Key API/Component Changes**
20e41f4b71Sopenharmony_ci
21e41f4b71Sopenharmony_ciList the API/component changes involved in the function change.
22e41f4b71Sopenharmony_ci
23e41f4b71Sopenharmony_ci**Adaptation Guide (Optional)**
24e41f4b71Sopenharmony_ci
25e41f4b71Sopenharmony_ciProvide guidance for developers on how to adapt their application to the changes to be compatible with the new version.
26e41f4b71Sopenharmony_ci
27e41f4b71Sopenharmony_ciExample:
28e41f4b71Sopenharmony_ci
29e41f4b71Sopenharmony_ciChange parameter *n* to *m* in the *a* file.
30e41f4b71Sopenharmony_ci
31e41f4b71Sopenharmony_ci```
32e41f4b71Sopenharmony_cisample code
33e41f4b71Sopenharmony_ci```
34