Skip to content

docs: add crate metadata to all Cargo.toml files (#91)#110

Open
Peolite001 wants to merge 1 commit into
BCPathway:mainfrom
Peolite001:docs/crate-metadata-91
Open

docs: add crate metadata to all Cargo.toml files (#91)#110
Peolite001 wants to merge 1 commit into
BCPathway:mainfrom
Peolite001:docs/crate-metadata-91

Conversation

@Peolite001
Copy link
Copy Markdown

@Peolite001 Peolite001 commented May 27, 2026

Summary

Adds standardized crate metadata to all Cargo.toml files to prepare the project for potential crates.io publishing. Uses Cargo workspace inheritance to share common fields across the workspace members.

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Smart contract improvement
  • 🧪 Test coverage improvement
  • 🏗️ CI/Build improvement

Related Issue

Closes #91

Changes Made

-Added [workspace.package] section to root Cargo.toml with shared metadata fields (license, repository, authors, categories, keywords, rust-version)
-Updated contracts/admin/Cargo.toml to inherit workspace metadata and add crate-specific description
-Updated contracts/lifecycle/Cargo.toml to inherit workspace metadata and add crate-specific description
-Updated contracts/token/Cargo.toml to use workspace inheritance instead of hardcoded values
-Added readme = "../../README.md" pointer to all contract crates
-Retained publish = false on all crates to prevent accidental publishing until ready

Testing

How has this been tested?

  • Rust unit tests pass (cargo test)
  • SDK compiles (npm run build in sdk/)
  • Manual testing against Soroban testnet
  • New tests added for changes

Test commands run:

# Verify workspace compiles with new metadata
cargo check

# Contract tests
cargo test

## Checklist

- [x] My code follows the project's style guidelines
- [ ] I have added NatSpec-style comments to new Rust functions
- [ ] I have added JSDoc comments to new TypeScript functions
- [ ] I have updated the README if needed
- [ ] My branch follows the naming convention: `feature/<issue-number>-<description>`
- [ ] I have not modified files outside the scope of this issue

## Drips.network Contributor Info

<!-- If you're contributing via drips.network, include your drips profile link -->

- **Drips Profile**: [https://www.drips.network/wave/users/fb91e94e-2870-4c67-ba63-fe61d40229d6]
- **Issue Claimed**: #91

- Add workspace-level shared metadata (license, repository, authors, etc.)
- Inherit metadata in all contract crates via workspace inheritance
- Add categories and keywords for crates.io discoverability
- Set rust-version to 1.74 matching project prerequisites
- Keep publish = false until ready for crates.io release
@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 27, 2026

@Peolite001 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

[Docs] Add Crate Metadata to Cargo.tomls

1 participant