Skip to content

Commit

Permalink
docs: add deprecation linking
Browse files Browse the repository at this point in the history
  • Loading branch information
wzhudev committed Jan 23, 2025
1 parent 4cba6ef commit e52b352
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,6 @@ Please refer to [How to Contribute to Facade API](./docs/CONTRIBUTING.md).

If you are going to deprecate an API, please follow the steps below:

1. Mark the API as deprecated in the JSDoc.
1. Mark the API as deprecated in the JSDoc, and use `{@link }` to refer to the new API.
2. In the implementation, call `deprecate` of `ILogService` to log a deprecation message.
3. Remove the API in the next minor version. If the API is considered heavily used, you can remove it in the next major version, e.g. 1.0.0.

0 comments on commit e52b352

Please sign in to comment.