​

Contributing to IPTF Map

​

How to Contribute

​

Adding a Vendor or Protocol

1. Check for duplicates - Review the vendors directory to ensure the vendor isn’t already documented
2. Use the template - Create a new file following the vendor template structure
3. Include key information:
   • Technical architecture and approach
   • Supported privacy patterns
   • Integration considerations
   • Production maturity and deployment status
   • Links to documentation and resources
4. Submit a Pull Request - Use the vendor template when creating your PR

​

Adding an Enterprise Use Case

1. Review existing content - Check the use-cases and approaches directories
2. Choose the right location:
   • Use cases: High-level business requirements
   • Approaches: Technical solution patterns
3. Create your file - Follow the use-case template
4. Submit a Pull Request - Describe the use case and relevant context

​

Content Guidelines

​

Be Accurate

• Provide factual, verifiable information
• Avoid marketing language and unsubstantiated claims
• Include links to source documentation
• Distinguish between production and development features

​

Check for Duplicates

• Search existing files before adding new content
• Update existing pages rather than creating duplicates
• Link to related content instead of repeating information

​

Include Working Links

• Test all documentation and resource links
• Use official sources when available
• Provide archive links for important references

​

Use Semantic Commits

• feat: - New vendor, pattern, use case, or approach
• fix: - Corrections to existing content
• docs: - Documentation updates
• refactor: - Reorganizing content without changing meaning
• chore: - Maintenance tasks

feat: add Acme Protocol vendor page
fix: correct Aztec sequencer architecture details
docs: improve contributing guidelines

​

Changelog Updates

1. Add an entry to the [Unreleased] section in CHANGELOG.md
2. Include a markdown link to the new file
3. Reference the PR number if applicable

### Added
- feat(vendor): [Acme Protocol](vendors/acme.md) - ZK-based privacy solution (#123)

​

Weekly Summaries

# Last 7 days
./scripts/weekly-summary.sh

# Custom date range
./scripts/weekly-summary.sh 2026-01-08 2026-01-15

​

Review Process

​

Pull Request Reviews

1. Automated checks - PRs run validation for:
   • Markdown formatting
   • Broken links
   • Required frontmatter fields
2. Community review - Maintainers and community members review for:
   • Technical accuracy
   • Content completeness
   • Appropriate tone and style
3. Merge criteria:
   • All checks passing
   • At least one approving review
   • No unresolved discussions

​

Getting Help

​

Questions and Discussion

• GitHub Issues - For specific bugs or content corrections
• GitHub Discussions - For broader questions and topics
• Repository - ethereum/iptf-map

​

Contact

• Open an issue on GitHub
• Participate in GitHub Discussions
• Review existing documentation and examples

​

Code of Conduct

• Be respectful and professional
• Focus on technical accuracy
• Assume good faith in others’ contributions
• Help maintain a welcoming environment

​

License