-
Notifications
You must be signed in to change notification settings - Fork 16
Description
🚀 Goal
Enhance the Web5 Rust CLI by improving documentation, adding new features, and expanding existing functionality.
🤔 Background
The Web5 Rust CLI is a powerful tool for working with decentralized identifiers (DIDs) and verifiable credentials (VCs). This project aims to make it more user-friendly and feature-rich.
🤝 Pick up ONE of the following issues to contribute
We've broken down the Web5 Rust CLI implementation into smaller tasks. Feel free to take on any task that interests you. Every contribution counts!
Each subtask is detailed in its own issue. Please refer to the individual issues for specific requirements and acceptance criteria.
💻 Coding Tasks (Rust specific)
- (Feature): Add ability to pass in additional-properties in Web5 CLI to
web5 vc create#326 - (Feature): Add command and functionality to parse/decode signed JWT in Web5 CLI #327
- (Feature): Add command and functionality to create a presentation definition #328
- Add warning to the Web5 Rust CLI if they're not running as root #380
- 🐛 Bug: Fix Web5 CLI Installation Script #384
- Make Web5 CLI compatible with Windows (Bash/WSL and PowerShell) #386
- Implement
mktempfunctionality in Web5 CLI #387 - Implement Post-Installation Verification for Web5 CLI #388
📚 Documentation
- (Docs) Add to README: How to create a did:jwk in the CLI #323
- (Docs) Add to README: How to create a did:web in the CLI #324
- (Docs) Add to README: Clearer indication of optional and required arguments for web5 vc create #325
📋 Overall Acceptance Criteria
- All subtasks are completed and their respective issues closed
- Documentation is updated to reflect all new features and changes
- New features are thoroughly tested and working as expected
- Code follows the project's style guidelines and best practices
- Pull requests for each subtask are reviewed and approved
🌟 Resources
- Web5 Documentation
- Web5 Rust CLI Repository
- Web5 CLI built in Go for reference
- Rust Documentation Guidelines
- JWT.io (for JWT-related tasks)
🎊 Hacktoberfest
This project is part of Hacktoberfest! We welcome contributions from technologists of all skill levels. Here's how you can get started:
- Read the contributing guidelines
- Read the code of conduct
- Choose a subtask you'd like to work on
- Comment on the subtask's issue to get assigned
- Fork the repository and create a new branch for your work
- Complete the subtask following the criteria in its issue
- Submit a pull request with your changes
- Respond to any feedback during the review process
Questions?
If you have any questions or need clarification on any of the subtasks, please comment on the relevant issue or join our Discord community!
Happy coding! 🎉