chore: Migration Guide

comphead · Dec 19, 2024 · c967134 · c967134
1 parent 74351d3
commit c967134
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md
@@ -172,7 +172,7 @@ Some things to specifically check:
 
 1. Is the feature or fix covered sufficiently with tests (see the [Testing](testing.md) section)?
 2. Is the code clear, and fits the style of the existing codebase?
-3. Does the PR introduce a [breaking change](https://datafusion.apache.org/library-user-guide/api-health.html#breaking-changes)? If so the `api_change` Github badge needs to be added to the PR and migration documentation need to reflect changes according to [Migration Guidelines](https://datafusion.apache.org/library-user-guide/api-health.html#migration-guidelines)
+3. Does the PR introduce a [breaking change](https://datafusion.apache.org/library-user-guide/api-health.html#breaking-changes)? If so please follow the [breaking change policy](https://datafusion.apache.org/library-user-guide/api-health.html#breaking-changes) and migration documentation needs to be updated according to [Migration Guidelines](https://datafusion.apache.org/library-user-guide/api-health.html#migration-guidelines)
 
 ## Performance Improvements
 

diff --git a/docs/source/library-user-guide/api-health.md b/docs/source/library-user-guide/api-health.md
@@ -38,7 +38,7 @@ Compatibility Section of the cargo book]. Common examples of breaking changes:
 - Removing a `pub` function
 - Changing the return type of a function
 
-When making breaking public API changes, please add the `api-change` label to
+When making breaking public API changes, please add the `api change` label to
 the PR so we can highlight the changes in the release notes.
 
 [docs.rs page]: https://docs.rs/datafusion/latest/datafusion/index.html
@@ -72,7 +72,7 @@ Please refer to [DataFusion releases](https://crates.io/crates/datafusion/versio
 
 ## Migration Guidelines
 
-To ensure smooth upgrades and maintain application stability, the following guidelines must be followed for changes involving:
+To ensure smooth upgrades and maintain application stability, the following guidelines should be followed for changes involving:
 
 - Public API changes
 - Introducing deprecated methods