Skip to content

Commit 9cdce64

Browse files
committed
fix spelling and address feedback.
Co-authored-by: Marc Cenac <547446+mrcnc@users.noreply.github.com>
1 parent 51a4a3f commit 9cdce64

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

proposals/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Proposals
22

3-
This proposal process is intended for significantly impactfull additions to the Parquet spec. The goal is to facilitate those projects and help them being contributed to Parquet.
4-
For example, changes that are not backward compatible like adding a new encoding or a new compression algorithm (older implementations can not read new files).
3+
This proposal process is intended for significantly impactful additions to the Parquet spec. The goal is to facilitate those projects and help them being contributed to Parquet.
4+
For example, changes that are not forward compatible like adding a new encoding or a new compression algorithm (older implementations can not read new files). [see guidelines for more details](https://github.com/apache/parquet-format/blob/master/CONTRIBUTING.md#general-guidelinespreferences-on-additions)
55
This gives better visibility to those projects which require coordination in several implementations.
66
Bug fixes, code only features or minor changes to the spec that can be ignored by older implementations can simply be filed as a github issue.
77

@@ -17,7 +17,7 @@ Attaching a google doc to collect feedback and collaborate with the community wo
1717
*Transition:* Once you feel you received enough feedback or need to start the POC to have better answers to questions you get, you can move to the next step. Anybody is free to start POCs anytime. We just recommend getting feedback before you spend a significant amount of your time.
1818

1919
### Draft/POC
20-
Once you feel 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.
20+
Once you feel the discussion has stabilized and you are ready to start a POC, open a PR to add the proposal to the table in the [Active Proposals](#active-proposals) section bellow. Link all relevant discussion documents in the body of the corresponding github issue. If using google docs, make sure docs are owned by an account that will maintain them publicly (preffer personal account over a work account). Alternativaly you can create a new Markdown file in the proposals folder and give more visibility to the work in progress (see [the example](1_BASE64_ENCODING.md) ).
2121
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.
2222

2323
Example: [https://github.com/apache/parquet-format/pull/221]
@@ -27,7 +27,7 @@ Make sure you consider the [requirements document](https://docs.google.com/docum
2727
*Transition:* There is enough clarity on the spec for the new feature and we have identified the reference implementations to be implemented to be able to release.
2828

2929
### Implementation
30-
Once we have reached enough consensus on the formalized spec change and validated it through the POC, we should have a clear idea of whether we want to pursue the implementation accross the ecosystem.
30+
Once we have reached enough consensus on the formalized spec change and validated it through the POC, we should have a clear idea of whether we want to pursue the implementation across the ecosystem.
3131
At this stage we should finalize a formal spec contribution to parquet-format and we need to meet the contribution guidelines to consider the implementation finished.
3232
See [CONTRIBUTING guidelines](https://github.com/apache/parquet-format/blob/master/CONTRIBUTING.md#additionschanges-to-the-format).
3333

@@ -46,7 +46,7 @@ Once the implementation phase is finished, we can include the contribution in th
4646
## Implemented
4747
| ID | Description | Status | release it was added |
4848
|-----|--------------|---------|-----------------------|
49-
| [gihub issue] | encryption | Completed | x.y.z |
49+
| [github issue] | encryption | Completed | x.y.z |
5050

5151
## Archived
5252

proposals/_PROPOSAL_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Status: DRAFT|IMPLEMENTATION|COMPLETED
1212
*Short description of the proposal. Is it a new encoding? Is it backwards compatible (old readers will just ignore it)? Is it additional metadata?*
1313

1414
## Rationale
15-
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)
15+
Describe why this is a feature that will improve the parquet format and what alternatives currently exist for the use case (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")
1616

1717
## Spec
1818

0 commit comments

Comments
 (0)