Skip to main content

Contributing Guide

Thank you for your interest in contributing! This document covers how to contribute to the API, SDK, and documentation.

Active Development

The Web3 Identity API is under active development. Features may change, and you may encounter bugs. We appreciate bug reports and feedback — they help us improve!

Ways to Contribute​

TypeDescriptionWhere
🐛 Bug ReportsFound something broken?GitHub Issues
💡 Feature RequestsHave an idea?GitHub Discussions
📝 DocumentationImprove guides, fix typosPR to docs-site/
💻 SDK CodeEnhance the JavaScript SDKPR to packages/atv-x402-sdk/
🧪 TestingAdd test coveragePR with tests

Reporting Issues​

Before Submitting​

  1. Search existing issues — your problem may already be reported
  2. Check the status page — https://status.web3identity.com
  3. Try the latest version — npm update @atv-eth/x402-sdk

Bug Report Template​

## Description
Brief description of the bug

## Steps to Reproduce
1. Call endpoint X with parameter Y
2. Observe error Z

## Expected Behavior
What should happen

## Actual Behavior
What actually happens

## Environment
- SDK Version: 1.1.4
- Node.js Version: 20.x
- Operating System: macOS 14

Security Issues​

Do not open public issues for security vulnerabilities.

Email security concerns to: support@web3identity.com

Suggesting Features​

Open a GitHub Discussion with:

  • Use case: What problem does this solve?
  • Proposed solution: How should it work?
  • Alternatives considered: Other approaches you've thought about

Contributing Code​

Setup​

# Clone the SDK repository
git clone https://github.com/ATV-eth/x402-sdk.git
cd x402-sdk

# Install dependencies
npm install

# Run tests
npm test

Development Workflow​

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature
  3. Make changes with clear, focused commits
  4. Test thoroughly: npm test
  5. Submit PR with description of changes

Commit Messages​

Follow Conventional Commits:

feat: add batch price endpoint support
fix: handle null ENS records gracefully
docs: update authentication examples

Pull Request Guidelines​

  • One feature per PR — keep changes focused
  • Update documentation — if behavior changes
  • Add tests — maintain or improve coverage
  • Describe changes — what and why in PR description

Documentation Contributions​

Local Development​

cd docs-site
npm install
npm start
# Opens http://localhost:3000

Writing Guidelines​

  • Be concise — developers skim documentation
  • Include examples — code speaks louder than prose
  • Test code samples — ensure they actually work
  • Use consistent terminology — see Glossary

Adding a New Page​

  1. Create .md file in appropriate directory
  2. Add frontmatter: 
    ---
    sidebar_position: 5
    description: Brief description for SEO
    ---
  3. Write content with clear headings
  4. Test locally: npm start

SDK Contributions​

Adding a New Method​

  1. Add method to index.mjs
  2. Add TypeScript types
  3. Add tests
  4. Update README with example
  5. Update CHANGELOG

Questions?​

Thank you for helping make Web3 Identity API better! 🙏