Skip to content

MINOR: adding changes guidelines - #645

Open
julienledem wants to merge 2 commits into
apache:masterfrom
julienledem:add_change_guidelines
Open

julienledem wants to merge 2 commits into
apache:masterfrom
julienledem:add_change_guidelines

Conversation

@julienledem

@julienledem julienledem commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Rationale for this change

I created a page reflecting the content of the guidelines we have been discussing.
https://docs.google.com/document/d/19bOTy1WcLs9NP88DrysG4wG50pM6gmIFaSEWzkxUeJw/edit?tab=t.8veepidgez8a#heading=h.lkllwrkuv6vx

I initially opened it on parquet-site but moving it here, and now parquet-site renders content from this page

What changes are included in this PR?

This adds a page to the documentation

Do these changes have PoC implementations?

This is documentation.

Signed-off-by: Julien Le Dem <julien.ledem@datadoghq.com>
Signed-off-by: Julien Le Dem <julien.ledem@datadoghq.com>

@alamb alamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @julienledem -- this looks like a nice step forward to me

As I think @emkornfield has mentioned before, we now have two sources of somewhat overlapping information (FormatChanges.md and the README) which would be nice to consolidate eventually

Comment thread CONTRIBUTING.md
See [Changing the Format](FormatChanges.md) for more details on the categories
of changes and the criteria used to evaluate them.

New features are intended to be widely beneficial to users of Parquet, and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps as a follow on PR we can consolidate this text with the text in FormatChanges.md

Comment thread FormatChanges.md

## Dealing with incompatible changes

### Backward compatibility

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention something about deprecation here? If we intend to drop a field, we should likely be deprecating it in the current version so readers/writers have time to change if needed and then dropping it in the next version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants