Skip to content

Commit

Permalink
chore(dev): Detail the format of DEPRECATIONS.md file
Browse files Browse the repository at this point in the history
The format of this file was originally described in #14983

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko committed Nov 1, 2023
1 parent 051de5a commit 4480f6a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/DEPRECATIONS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
See [DEPRECATION.md](docs/DEPRECATION.md#process) for the process for updating this file.

The format for each entry should be: `<version> <identifier> <description>`.

- `<version>` should be the version of Vector in which to take the action (deprecate, migrate, or
remove)
- `<identifier>` should be a unique identifier that can also be used in the code to easily find the
places to modify
- `<description>` should be a longer form description of the change to be made

## To be deprecated

## To be migrated
Expand Down

0 comments on commit 4480f6a

Please sign in to comment.