Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (68 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

91 lines (68 loc) · 3.09 KB
Raw

Contributing to Awesome HyperEVM

Thank you for your interest in contributing to the Awesome HyperEVM list! This document provides guidelines and instructions for contributing.

How to Contribute

Here are the ways you can contribute to the Awesome HyperEVM list:

  1. Add a new resource: Submit a PR to add a new tool, service, or project related to HyperEVM
  2. Update existing information: Improve descriptions, update links, or add missing details
  3. Report issues: Report broken links, outdated information, or suggest improvements
  4. Improve organization: Suggest better ways to categorize or present information

Pull Request Process

  1. Fork the Repository: Create your own fork of this repository
  2. Create a Feature Branch: 
    git checkout -b descriptive-branch-name
# Example: git checkout -b add-new-wallet
  3. Commit Your Changes: 
    git commit -m "feat: add XYZ wallet to key management section"
  4. Push to Your Fork: 
    git push origin feature/your-feature-name
  5. Submit a Pull Request: Open a PR against the main branch of this repository

Contribution Guidelines

To maintain the quality of the Awesome HyperEVM list, please follow these guidelines:

  • Quality over quantity: Only add high-quality resources that you have personally used or verified
  • Maintain alphabetical order: Within each section, maintain alphabetical listing (unless a different order makes more sense)
  • Provide complete information: Include name, link, and a brief description
  • Be concise: Keep descriptions clear and to the point
  • No promotional content: Focus on value to developers, not marketing language
  • Check for duplicates: Make sure the resource isn't already listed
  • Verify links: Ensure all links are functional and point to the correct location
  • Use correct categorization: Add resources to the most appropriate section

Pull Request Template

When submitting a pull request, please include the following information:

## Description
Brief description of your addition or change.

## Type of Change
Indicate if this is a:
- New resource addition
- Update to existing resource
- Removal of outdated resource
- Documentation improvement
- Other (please describe)

Issue Reporting

If you find issues with the list or want to suggest improvements without submitting a PR, please create an issue using one of these templates:

Broken Link or Outdated Information

## Issue: [Broken Link/Outdated Information]

**Location**: [Section name and item]
**Current Information**: [What's currently there]
**Problem**: [Description of the issue]
**Suggested Fix**: [If you have a suggestion]

New Resource Suggestion

## Suggestion: Add New Resource

**Resource Name**: [Name]
**Link**: [URL]
**Category**: [Existing section it belongs in]
**Description**: [Brief description of what it is and why it's valuable]
**Why it should be included**: [What makes this resource valuable to HyperEVM developers]

Thank you for contributing to the Awesome HyperEVM ecosystem!