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

Move crates to dedicated crates folder #416

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Move crates to dedicated crates folder #416

merged 3 commits into from
Mar 4, 2024

Conversation

Rigidity
Copy link
Contributor

@Rigidity Rigidity commented Mar 4, 2024

There is no convention that I can find per se that says that workspaces should be organized like this, with a crates folder rather than putting all of the crates in the root. The closest thing I could find is this blog post by the creator of Rust Analyzer.

However, I think that this is the beginning of a list of changes I want to make:

  1. Move all of the crates into a dedicated crates folder to reduce clutter in the repository's root.
  2. Move the src folder and its actual dependencies into a new crate named chia-consensus.
  3. Turn chia into a meta-crate that re-exports each of the workspace's crates as togglable features that are enabled by default.
  4. Ideally, find a cleaner way to store test data than the ff-tests, cl, test-bundles, and generator-tests folders.
  5. Move the docs into actual documentation in the root of the appropriate crate.
  6. Add an examples folder, with examples for each thing you may want to do with chia_rs in Rust (maybe chia-tools should live there?).
  7. Improve test coverage.

@Rigidity Rigidity requested a review from arvidn March 4, 2024 01:27
Copy link

coveralls-official bot commented Mar 4, 2024

Pull Request Test Coverage Report for Build 8141003193

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 85.2%

Totals Coverage Status
Change from base Build 8115930322: 0.0%
Covered Lines: 11439
Relevant Lines: 13426

💛 - Coveralls

Copy link
Contributor

@arvidn arvidn left a comment

Choose a reason for hiding this comment

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

looks good in general. I'm not sure the globbing is a good idea though

crates/chia-protocol/Cargo.toml Show resolved Hide resolved
@Rigidity Rigidity requested a review from arvidn March 4, 2024 13:32
@Rigidity Rigidity merged commit 6ddbf9f into main Mar 4, 2024
64 checks passed
@Rigidity Rigidity deleted the crates-folder branch March 4, 2024 16:01
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.

2 participants