Skip to content

Commit

Permalink
Add a deprecation section to the Contributing notes (#2248)
Browse files Browse the repository at this point in the history
A brief explanation of the Deprecation Checklist is added to the
Contributing notes with a link to it
  • Loading branch information
juangirini authored Dec 12, 2023
1 parent ef62acf commit 6b5995f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/contributor/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,9 @@ We use [zepter](https://github.com/ggwpez/zepter) to enforce features are propag
If you're member of **paritytech** org - you can use command-bot to run various of common commands in CI:

Start with comment in PR: `bot help` to see the list of available commands.


## Deprecating code

When deprecating and removing code you need to be mindful of how this could impact downstream developers. In order to
mitigate this impact, it is recommended to adhere to the steps outlined in the [Deprecation Checklist](./DEPRECATION_CHECKLIST.md).
6 changes: 2 additions & 4 deletions docs/contributor/DEPRECATION_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Deprecation Checklist

This deprecation checklist makes sense while we don’t 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.

Expand Down

0 comments on commit 6b5995f

Please sign in to comment.