Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a deprecation section to the Contributing notes #2248

Merged
merged 7 commits into from
Dec 12, 2023
Merged

Add a deprecation section to the Contributing notes #2248

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8ef083d
add a link to the deprecation checklist
juangirini Nov 9, 2023
1552a5b
add newline
juangirini Nov 9, 2023
d13c252
fix typo
juangirini Nov 9, 2023
57c3a77
update semver info
juangirini Nov 9, 2023
68ceadb
fix md lines length
juangirini Nov 9, 2023
3f33662
Merge remote-tracking branch 'origin/master' into jg/add-deprecation-…
juangirini Dec 5, 2023
c400bfe
update checklist
juangirini Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,12 @@ will run the tests for the specified rust version and specified image
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

Polkadot SDK does not stick to [SemVer](https://semver.org/), thus breaking changes can happen between "minor version"
updates.
juangirini marked this conversation as resolved.
Show resolved Hide resolved
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).
Loading