Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (60 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 3.25 KB

Contributing to Awesome Gear Protocol

Thank you for your interest in contributing to the Awesome Gear Protocol list! This document outlines the guidelines for contributing to this curated collection of Gear Protocol and Vara Network resources.

What is Awesome Gear Protocol?

Awesome Gear Protocol is a curated list of high-quality resources, tools, libraries, frameworks, and examples related to the Gear Protocol and Vara Network ecosystem. The list follows the Awesome Manifesto principles.

How to Contribute

Adding a New Resource

  1. Check existing entries: Make sure your resource isn't already listed
  2. Follow the format: Use the existing format in the README.md file
  3. Provide context: Include a brief description of what the resource offers
  4. Use proper links: Ensure all links are valid and point to the correct resources

Contribution Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-resource)
  3. Add your resource to the appropriate section in README.md
  4. Test your changes by running the awesome-lint check locally
  5. Commit your changes with a clear commit message
  6. Create a Pull Request

Guidelines for Entries

  • Quality over quantity: Only include resources that provide genuine value
  • Keep descriptions brief: Aim for 1-2 sentences maximum
  • Use consistent formatting: Follow the existing markdown format
  • Verify links: Ensure all URLs are working and point to the intended resource
  • Categorize properly: Place resources in the most appropriate section

Running Awesome Lint

This repository uses awesome-lint to maintain quality standards. You can run it locally:

npx awesome-lint README.md

Pull Request Requirements

  • Clear title: Describe what you're adding
  • Description: Explain why this resource should be included
  • Screenshots/Demos: Include if relevant (especially for tools and applications)
  • Verification: Confirm the resource meets the quality criteria

Categories

The list is organized into the following sections:

  • Standards: Token standards, service interfaces
  • Frameworks: Development frameworks and libraries
  • Libraries: Core crates and utilities
  • Examples: Code examples and templates
  • Tools: Development tools and CLI applications
  • IDEs: Integrated development environments
  • Wallets: Cryptocurrency wallets with Gear/Vara support
  • SDKs: Software development kits
  • Papers: Technical papers and research
  • Videos: Educational and tutorial videos
  • Blog Posts: Technical blog articles

Quality Standards

Resources should be:

  • Maintained: Actively maintained projects preferred
  • Documented: Well-documented with clear usage instructions
  • Stable: Stable APIs and reliable functionality
  • Relevant: Directly related to Gear Protocol or Vara Network
  • Professional: High-quality code and presentation

Reporting Issues

If you find:

  • Broken links
  • Outdated information
  • Missing important resources
  • Entries that don't meet quality standards

Please create an issue or submit a pull request with your suggested changes.