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

Reorganize crates in the repository #1528

Closed
4 of 5 tasks
jpraynaud opened this issue Feb 23, 2024 · 0 comments · Fixed by #1540
Closed
4 of 5 tasks

Reorganize crates in the repository #1528

jpraynaud opened this issue Feb 23, 2024 · 0 comments · Fixed by #1540
Assignees
Labels
refactoring 🛠️ Code refactoring and enhancements

Comments

@jpraynaud
Copy link
Member

jpraynaud commented Feb 23, 2024

Why

We have created many crates lately and we feel that we need to re-organize the folder structure to make it clearer.

What

Define a clear separation between "released" crates and "internal" crates, by moving all utility/test crates in a specific folder (e.g mithril-internal).

How

  • Move utility crates in a new folder (internal?) of the repository (mithril-persistence, mithril-doc, mithril-doc-derive, mithril-build-script)
  • Migrate mithril-common build script in mithril-build-script
  • Fix the crates table generation in the release notes to support "released" crates only
  • Publish mithril-build-script in crates.io
  • The API reference page on the documentation needs to be updated with new crates, and mention an access to crates.io and npmjs.com when appropriate.
@jpraynaud jpraynaud added refactoring 🛠️ Code refactoring and enhancements to-groom 🤔 Needs grooming labels Feb 23, 2024
@jpraynaud jpraynaud removed the to-groom 🤔 Needs grooming label Feb 27, 2024
@Alenar Alenar mentioned this issue Feb 27, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring 🛠️ Code refactoring and enhancements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants