Skip to content

contributing.md

Latest commit

 

History

History
118 lines (80 loc) · 2.69 KB

contributing.md

File metadata and controls

118 lines (80 loc) · 2.69 KB
Raw

Contributing

Thank you for your interest in contributing to did:webs! This document provides guidelines for contributing to the specification, implementations, and documentation.

Ways to Contribute

There are many ways to contribute to the did:webs ecosystem:

1. Specification Development

Help improve the did:webs specification:

  • Review and provide feedback on the specification
  • Propose enhancements or clarifications
  • Report ambiguities or errors
  • Contribute use cases and examples

Repository: kswg-did-method-webs-specification

2. Reference Implementation

Contribute to the Python reference implementation:

  • Fix bugs
  • Add features
  • Improve performance
  • Enhance documentation
  • Write tests

Repository: did-webs-resolver

3. Documentation

Help improve documentation:

  • Fix typos and errors
  • Add examples and tutorials
  • Improve clarity
  • Translate documentation
  • Create video tutorials

Repository: This site's documentation

4. Testing

Help test did:webs:

  • Test the reference implementation
  • Report bugs
  • Create test vectors
  • Validate against the specification
  • Test interoperability

5. Community Support

Help others in the community:

  • Answer questions on GitHub
  • Help troubleshoot issues
  • Share your experiences
  • Write blog posts
  • Give presentations

6. New Implementations

Create implementations in other languages:

  • JavaScript/TypeScript
  • Rust
  • Go
  • Java
  • Others

Getting Started

See the getting started guide or the quickstart.

Prerequisites

Before contributing, familiarize yourself with:

Setting Up Your Environment

For Specification Work:

git clone https://github.com/trustoverip/kswg-did-method-webs-specification.git
cd kswg-did-method-webs-specification
npm install
npm run edit

For Implementation Work:

git clone https://github.com/GLEIF-IT/did-webs-resolver.git
cd did-webs-resolver
uv lock
uv sync
source .venv/bin/activate
pytest

Questions?

If you have questions about contributing:

  1. Check this guide
  2. Review existing issues and PRs
  3. Ask in a GitHub issue
  4. Contact the maintainers

Thank you for contributing to did:webs! Your contributions help make decentralized identity more secure and accessible.