mirror of
https://github.com/langchain-ai/datafusion.git
synced 2026-08-26 18:06:36 -04:00
8df75c3f04
## Which issue does this PR close? ## Rationale for this change DataFusion does make API changes from time to time, and that is a normal part of software development. However, it is important to evaluate the impact of those API changes on downstream users and to ensure that the benefits of the change are clear to those users. I found a few times where API changes were made with the justification that "some APIs in DataFusion are cleaner" or "this is more consistent with other APIs". While those may be valid justifications, it is painful for downstream users who have change their code to accommodate the API change when they get nothing in return This most recently happened in this PR - https://github.com/apache/datafusion/pull/19790#pullrequestreview-3863480182 thus I think the contributor guide should include some guidance on how to evaluate breaking API changes and to ensure that the benefits of the change are clear to downstream users. ## What changes are included in this PR? Polish up the API guidance section ## Are these changes tested? By CI ## Are there any user-facing changes? Better / clearer docs