-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs - include deprection workflow
- Loading branch information
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
docs/schulcloud-server/Coding-Guidelines/deprection-workflow.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |