Skip to content

Latest commit

 

History

History
181 lines (126 loc) · 5.38 KB

CONTRIBUTING.md

File metadata and controls

181 lines (126 loc) · 5.38 KB

Contributing to Awesome ERC-8004

Thank you for your interest in contributing to the Awesome ERC-8004 list! This document provides guidelines for contributing resources and maintaining the quality of this curated list.

How to Contribute

1. Before Contributing

  • Check if your resource is already listed
  • Read the Awesome List Guidelines
  • Ensure your resource is directly related to ERC-8004 or trustless agents
  • Verify that links are working and resources are accessible

2. What to Contribute

We welcome the following types of contributions:

✅ Accepted Resources

  • Implementations: Libraries, frameworks, or reference implementations of ERC-8004
  • Tools: Developer tools, SDKs, CLI tools, or utilities for working with ERC-8004
  • Documentation: Guides, tutorials, API documentation, or educational content
  • Research: Academic papers, research findings, or technical analysis
  • Community Projects: Open-source projects implementing or using ERC-8004
  • Standards: Related standards, protocols, or specifications
  • Discussion Summaries: Well-documented insights from community discussions

❌ Not Accepted

  • Dead links or abandoned projects
  • Paid/commercial content without clear community value
  • Duplicate entries
  • Resources unrelated to ERC-8004
  • Low-quality or spam content
  • Personal projects without community relevance

3. Contribution Process

Option A: GitHub Issues (Recommended for single additions)

  1. Create a new issue
  2. Use the title format: Add: [Resource Name]
  3. Provide the following information: 
    **Resource Name**:
**URL**:
**Category**:
**Description**:
**Why it should be included**:

Option B: Pull Request (For multiple additions or changes)

  1. Fork this repository
  2. Create a new branch: git checkout -b add-resource-name
  3. Add your resource to the appropriate section in README.md
  4. Follow the formatting guidelines below
  5. Commit your changes: git commit -m "Add [Resource Name]"
  6. Push to your branch: git push origin add-resource-name
  7. Create a pull request

4. Formatting Guidelines

Link Format

- [Resource Name](URL) - Brief description explaining what it is and why it's useful

Examples

- [ERC-8004 TypeScript SDK](https://github.com/example/erc8004-sdk) - TypeScript SDK for integrating ERC-8004 registries with type safety and comprehensive documentation
- [Trustless Agent Tutorial](https://example.com/tutorial) - Step-by-step guide to building your first trustless agent using ERC-8004

Section Placement

Place resources in the most appropriate section:

  • Official Resources: Only EIP authors and Ethereum Foundation content
  • Implementations: Code libraries and frameworks
  • Tools & Libraries: Developer utilities and SDKs
  • Documentation & Guides: Educational content
  • Community Projects: Projects built by the community
  • Research & Papers: Academic and research content
  • Development Resources: Standards, references, and development aids

5. Quality Standards

All Resources Must:

  • Be publicly accessible (no paywalls or login requirements)
  • Have clear relevance to ERC-8004
  • Be actively maintained (check last update date)
  • Provide value to the community
  • Have working links

Descriptions Should:

  • Be concise (1-2 sentences maximum)
  • Explain what the resource is
  • Highlight why it's useful
  • Use proper grammar and spelling
  • Avoid marketing language

6. Review Process

  1. Automated Checks: Links will be automatically checked for availability
  2. Community Review: Other contributors may review and comment
  3. Maintainer Approval: Final approval by repository maintainers
  4. Feedback: You may receive feedback for improvements

7. Updating Existing Resources

If you notice outdated information or broken links:

  1. Create an issue or pull request
  2. Clearly describe what needs to be updated
  3. Provide the correct information or working alternative

8. Community Guidelines

Be Respectful

  • Respect other contributors and their work
  • Provide constructive feedback
  • Follow the GitHub Community Guidelines

Stay On Topic

  • Keep discussions focused on ERC-8004
  • Use appropriate labels and categories

Quality Over Quantity

  • We prefer fewer high-quality resources over many low-quality ones
  • Each addition should provide unique value

9. Recognition

Contributors will be recognized in several ways:

  • GitHub contribution history
  • Mention in release notes for significant contributions
  • Community acknowledgment for valuable resources

10. Questions and Support

If you have questions about contributing:

  1. Check existing issues
  2. Create a new issue with the label question
  3. Join the discussion in the Ethereum Magicians forum

Resource Template

When adding a new resource, you can use this template:

**Resource Information:**

- Name:
- URL:
- Category:
- Description:
- Last Updated:
- Language/Framework:
- License:
- Maintenance Status:

**Why should this be included?**

**Additional Notes:**

Thank you for helping make this the best resource for the ERC-8004 community! 🚀