alamb commented on code in PR #513: URL: https://github.com/apache/parquet-format/pull/513#discussion_r2266827133
########## proposals/README.md: ########## @@ -0,0 +1,50 @@ +# Proposals + +## Requirements + +See the [requirements document](https://docs.google.com/document/d/1qGDnOyoNyPvcN4FCRhbZGAvp0SfewlWo-WVsai5IKUo/edit?tab=t.0#heading=h.v4emiipkghrx) (Note: this doc would become a markdown page in the repo) + +## Proposal lifecycle + +Discuss -> Draft -> POC -> Approved -> Implementation -> Release + +### Discuss +Start a [DISCUSS] thread on the mailing list ([email protected]) with your idea. +Once you have a better idea of the direction, open a github issue using the proposal template. +You can attach a google doc to collaborate on the general idea with the community. + +### Draft +Once the discussion has stabilized and you are ready to start a POC, open a PR to add a new Markdown file in the proposals folder and give more visibility to the work in progress. + +### POC +The proposal document can evolve along the course of the POC. In particular to add more links to findings and performance evaluations. Collaboration is encouraged. More validation on the POC increases the chances of success. + +Make sure you consider the [#Requirements] to ensure the success of the POC. Review Comment: I recommend combining the Draft / POC stage -- it seems like any change also has a POC that shows what the proposal looks like in code so it makes more sense to me if they are combined ########## proposals/README.md: ########## @@ -0,0 +1,50 @@ +# Proposals + +## Requirements + +See the [requirements document](https://docs.google.com/document/d/1qGDnOyoNyPvcN4FCRhbZGAvp0SfewlWo-WVsai5IKUo/edit?tab=t.0#heading=h.v4emiipkghrx) (Note: this doc would become a markdown page in the repo) + +## Proposal lifecycle + +Discuss -> Draft -> POC -> Approved -> Implementation -> Release + +### Discuss +Start a [DISCUSS] thread on the mailing list ([email protected]) with your idea. +Once you have a better idea of the direction, open a github issue using the proposal template. +You can attach a google doc to collaborate on the general idea with the community. + +### Draft +Once the discussion has stabilized and you are ready to start a POC, open a PR to add a new Markdown file in the proposals folder and give more visibility to the work in progress. Review Comment: Perhaps you can link to some examples, such as - https://github.com/apache/parquet-format/pull/221 ########## proposals/README.md: ########## @@ -0,0 +1,50 @@ +# Proposals + +## Requirements + +See the [requirements document](https://docs.google.com/document/d/1qGDnOyoNyPvcN4FCRhbZGAvp0SfewlWo-WVsai5IKUo/edit?tab=t.0#heading=h.v4emiipkghrx) (Note: this doc would become a markdown page in the repo) + +## Proposal lifecycle + +Discuss -> Draft -> POC -> Approved -> Implementation -> Release + +### Discuss +Start a [DISCUSS] thread on the mailing list ([email protected]) with your idea. +Once you have a better idea of the direction, open a github issue using the proposal template. +You can attach a google doc to collaborate on the general idea with the community. + +### Draft +Once the discussion has stabilized and you are ready to start a POC, open a PR to add a new Markdown file in the proposals folder and give more visibility to the work in progress. + +### POC +The proposal document can evolve along the course of the POC. In particular to add more links to findings and performance evaluations. Collaboration is encouraged. More validation on the POC increases the chances of success. + +Make sure you consider the [#Requirements] to ensure the success of the POC. + +### Approved for Implementation +Once the POC has concluded, we should have a clear idea of whether we want to pursue the implementation accross the ecosystem. A PMC vote will formalize that stage + +### Implementation +At this stage we need to meet the contribution guidelines to confsider the implementation finished (ex: two independent implementations with cross compatibility tests, spec updated, ...) Review Comment: I recommend combining "Approved for Implementation" and "Implementation" -- and highlighting that at this stage you will have convinced someone to implement the proposal in at least one other open source implementation and that showing at least those two implementations are interoperable ########## proposals/_PROPOSAL_TEMPLATE.md: ########## @@ -0,0 +1,22 @@ +# Proposal + +--- +Author: ~your name~ +Created: ~date~ +Name: *short sentence describing the proposal* +Issue: https://github.com/apache/parquet-format/issues/NNN +Status: DRAFT|POC|ACCEPTED|COMPLETED +--- + +## Description Review Comment: I recommend also adding a "## Rationale" section: Describe why this is a feature that will improve the parquet format and what alternatives currently exist for the usecase (e.g. must use a different format, or "must build additional infrastructure to avoid re-parsing footer on each query", or "must use a general purpose compression algorithm to achieve the same space, thus slowing down query performance) ########## proposals/README.md: ########## @@ -0,0 +1,50 @@ +# Proposals + +## Requirements + +See the [requirements document](https://docs.google.com/document/d/1qGDnOyoNyPvcN4FCRhbZGAvp0SfewlWo-WVsai5IKUo/edit?tab=t.0#heading=h.v4emiipkghrx) (Note: this doc would become a markdown page in the repo) + +## Proposal lifecycle + +Discuss -> Draft -> POC -> Approved -> Implementation -> Release + +### Discuss +Start a [DISCUSS] thread on the mailing list ([email protected]) with your idea. +Once you have a better idea of the direction, open a github issue using the proposal template. +You can attach a google doc to collaborate on the general idea with the community. + +### Draft +Once the discussion has stabilized and you are ready to start a POC, open a PR to add a new Markdown file in the proposals folder and give more visibility to the work in progress. + +### POC +The proposal document can evolve along the course of the POC. In particular to add more links to findings and performance evaluations. Collaboration is encouraged. More validation on the POC increases the chances of success. + +Make sure you consider the [#Requirements] to ensure the success of the POC. + +### Approved for Implementation +Once the POC has concluded, we should have a clear idea of whether we want to pursue the implementation accross the ecosystem. A PMC vote will formalize that stage + +### Implementation +At this stage we need to meet the contribution guidelines to confsider the implementation finished (ex: two independent implementations with cross compatibility tests, spec updated, ...) + +### Release +Once the implementation phase is finished, we can include the contribution in the next release. + +## Active Proposals Review Comment: this is a nice way to list / find the active proposal ########## proposals/README.md: ########## @@ -0,0 +1,50 @@ +# Proposals + +## Requirements + +See the [requirements document](https://docs.google.com/document/d/1qGDnOyoNyPvcN4FCRhbZGAvp0SfewlWo-WVsai5IKUo/edit?tab=t.0#heading=h.v4emiipkghrx) (Note: this doc would become a markdown page in the repo) + +## Proposal lifecycle + +Discuss -> Draft -> POC -> Approved -> Implementation -> Release Review Comment: I suggest reducing the number of stages here to make the process seem less daunting and more accurately describe the community aspect Specifically, I suggest *NOT* putting the PMC into a gatekeeping role for deciding if the community can try to implement proposals -- instead I think the the PMC should keep the formal gatekeeping activity restricted to the final approved modification to the spec. This will reduce the administrative burden on both proposals and the PMC. ```suggestion Discuss -> Draft / POC -> Implementations -> Approval ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
