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

Cargo design doc #441

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

brunoapimentel
Copy link
Contributor

@brunoapimentel brunoapimentel commented Jan 3, 2024

Early draft of the design doc for implementing Cargo support. There are a few sections still marked as TODO, most notably all the commentary on the Cargo+Pip support. So don't waste too much time in the details, this is bound to change quite a bit still.

It is also worth checking the test repo: https://github.com/cachito-testing/cachi2-rust. Same as this design doc, it is still a WIP.

I opened this as a PR because the length of the document would make it a little bit more unconfortable to review in the Github discussions format, and also to test if PRs could be an overall better way to handle design docs and other discussions.

Maintainers will complete the following section

  • Commit messages are descriptive enough
  • Code coverage from testing does not decrease and new code is covered
  • Docs updated (if applicable)
  • Docs links in the code are still valid (if docs were updated)

@brunoapimentel brunoapimentel force-pushed the cargo-design-doc branch 2 times, most recently from 3cedb9b to 6057428 Compare January 4, 2024 00:38
Signed-off-by: Bruno Pimentel <[email protected]>
@eskultety
Copy link
Member

it'll be a while before I get to read/understand/review this, but kudos for pushing the "PR for designs" way. Feels like it's going to be more ergonomic + we can not only close the PR, but also retain the doc for future reference, OR convert it to docs, i.e. it gives us a bit more flexibility.

@eskultety eskultety added the design doc A new feature design (blueprint) label Jan 4, 2024
@eskultety eskultety mentioned this pull request Aug 22, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design doc A new feature design (blueprint)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants