Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds skeleton for the initial crates for PartiQL. #2

Merged
merged 1 commit into from
Apr 30, 2021

Conversation

almann
Copy link
Contributor

@almann almann commented Apr 30, 2021

Also adds ignore file.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@almann
Copy link
Contributor Author

almann commented Apr 30, 2021

If helpful this is the differences between the Cargo.toml in the sub-crates below:

❯ for X in partiql-*/Cargo.toml; do diff partiql/Cargo.toml $X; done
2c2
< name = "partiql"
---
> name = "partiql-eval"
4c4
< description = "PartiQL in Rust"
---
> description = "PartiQL Expression Evaluator"
2c2
< name = "partiql"
---
> name = "partiql-irgen"
4c4
< description = "PartiQL in Rust"
---
> description = "PartiQL IR Generator"
2c2
< name = "partiql"
---
> name = "partiql-parser"
4c4
< description = "PartiQL in Rust"
---
> description = "PartiQL Parser"
2c2
< name = "partiql"
---
> name = "partiql-rewriter"
4c4
< description = "PartiQL in Rust"
---
> description = "PartiQL Rewriter Framework"

Copy link
Member

@dlurton dlurton left a comment

Choose a reason for hiding this comment

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

I see that you have a LICENSE file for each of the crates. Does there also need to be one at the root of the project as well?

Do we need README.md at the root and possibly also in each of the crate directories as well? If not in the crate directories, I think the root README.md should list each of the crates and have a brief description of each.

Otherwise LGTM.

@almann
Copy link
Contributor Author

almann commented Apr 30, 2021

I see that you have a LICENSE file for each of the crates. Does there also need to be one at the root of the project as well?

Do we need README.md at the root and possibly also in each of the crate directories as well? If not in the crate directories, I think the root README.md should list each of the crates and have a brief description of each.

We don't, futures sub-crates just refers to the parent's README. The LICENSE file is a symlink.

name = "partiql-eval"
authors = ["PartiQL Team <partiql-team@amazon.com>"]
description = "PartiQL Expression Evaluator"
homepage = "https://github.com/partiql/partiql-lang-rust"
Copy link
Member

Choose a reason for hiding this comment

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

nit: Should the homepage of this crate/package link to the subdirectory .../partiql-eval? Similarly for the other crates.

Copy link
Contributor Author

@almann almann Apr 30, 2021

Choose a reason for hiding this comment

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

Good question futures is where I cribbed this from, it is the example in the edition guide.

To answer your question though, in that workspace, there is just one home page for all the sub-crates.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am motivated to follow the above because I don't actually want to maintain N READMEs

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