Add a deprecation section to the Contributing notes (#2248)

A brief explanation of the Deprecation Checklist is added to the
Contributing notes with a link to it
This commit is contained in:
Juan Girini
2023-12-12 14:24:27 +01:00
committed by GitHub
parent ef62acfbcf
commit 6b5995ffd1
2 changed files with 8 additions and 4 deletions
+2 -4
View File
@@ -1,9 +1,7 @@
# Deprecation Checklist
This deprecation checklist makes sense while we dont use [SemVer](https://semver.org/).
After that, this document will most likely change.
As deprecation and removal of existing code can happen on any release, we need to be mindful that external builders
could be impacted by the changes we make.
Polkadot SDK is under constant development and improvement, thus deprecation and removal of existing code happen often.
When creating a breaking change we need to be mindful that external builders could be impacted by this.
The deprecation checklist tries to mitigate this impact, while still keeping the developer experience, the DevEx, as
smooth as possible.