Add guidelines to updating projects

rewrite-bigdata-in-rust / RBIR

A collection of RBIR projects and posts for anyone interested in joining this journey.

196 stars 7 forks source link

Add guidelines to updating projects #32

Open prrao87 opened 2 months ago

prrao87 commented 2 months ago

Added a section towards the end of the README to help people know how to add new projects, along with some guidelines.

prrao87 commented 2 months ago

@Xuanwo I wanted to learn the purpose of the path field in the Parquet and Avro library sections?

[[library]]
description = "Rust implementation of [Apache Parquet](https://parquet.apache.org/)"
name = "Apache Parquet Rust"
path = "/parquet"
repo = "https://github.com/apache/arrow-rs"

[[library]]
description = "Rust implementation of [Apache Avro](https://avro.apache.org/)"
name = "Apache Avro Rust"
path = "/lang/rust"
repo = "https://github.com/apache/avro"

The other libraries don't have this.

sanders41 commented 2 months ago

The path is not currently being used, but what I believe it's intended purpose will(?) be is the projects that have a path are part of larger mixed projects. So Apache Parquet Rust is part of the arrow-rs project, but not the only part. Same with Apache Avro Rust.

Taking Apache Avro as an example, the path to the rust files is https://github.com/apache/avro/tree/main/lang/rust. So the path /lang/rust could sort of get you there by appending to the repo, but you would also need to add /tree/main.