search

aurae-runtime / aurae

Distributed systems runtime daemon written in Rust.
https://aurae.io
Apache License 2.0
1.84k stars 90 forks source link

s/aurae-proto/proto/ #372

Closed dmah42 closed 1 year ago

dmah42 commented 1 year ago

part of #371

simplify the view of things by removing the previx.

dmah42 commented 1 year ago

gonna escalate this to @krisnova for BDFL approval.

krisnova commented 1 year ago

Curious why @future-highway thinks we shouldn't rename the directory?

I have a weakly held opinion that we should try not to use the name of the project in nested folder names, but if there is a good reason for it such as "This is the main Aurae API" I am actually okay with it.

dmah42 commented 1 year ago

proto is not the main API (that's in api) but if we ever publish aurae-proto or aurae-client as crates, we'd want the prefix in there.

i assume we can publish a crate called "aurae-foo" from a directory called "foo" but i don't know for sure.

future-highway commented 1 year ago

By convention, the crate name would match the directory name but I don't believe there is a technical requirement at any point, including publishing a crate. I think it's ok to rename if that is the preference.

dmah42 commented 1 year ago

ready to merge :)

krisnova commented 1 year ago

Looked at this on the stream and I think we are okay with have packages names foo that are published to crates.io as aurae-foo.

Additionally we now have control crates.io/crates/aurae which maybe is where we want to publish crates such as the client?

I am wondering under what conditions a developer would try:

cargo add aurae

and I think maybe the expectation is to get the rust client? although we can make that decision later!

Hope this helps explain my reasoning. Basically I am convinced we will likely be renaming/mapping these directories to other crate names (and maybe even repos?) in the future.