Skip to content

Commit

Permalink
update docs - include deprection workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
EzzatOmar committed Jan 25, 2024
1 parent 258ff52 commit 19d8e6a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/schulcloud-server/Coding-Guidelines/deprection-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Deprecation Workflow

## When to use 2 step migration

When we are replacing code which is used in other modules we should use a 2 step migration.
This is meant to prevent merge conflicts and to make it easier to review the changes.
Also it makes it easier to find the code which needs to be changed in the other modules.
Please note that this is not always possible, but should be used when possible.

Step 1: Add new alternative code
Step 2: Mark the old code with "@deprecated" add a hint in the comments to use the new code.
Step 3: Inform team
Step 4: Remove deprecated code (when is hard to say, once all dependencies are removed)

0 comments on commit 19d8e6a

Please sign in to comment.