Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.56 KB
Raw

Essential Eth Contributing Guide

Thank you for your interest in contributing to Essential Eth! We appreciate your effort to help us create smaller bundle sizes for emerging markets. 🙌🌍 This guide will help you understand the types of contributions and the process of making them.

Types of contributions

  • ✨ New feature: Implementing new features or enhancements to improve the functionality of Essential Eth.
  • 🐛 Bugfix: Identifying and fixing bugs or issues in the codebase.
  • 🧼 Cleanup: Improving code quality, removing unused code or files, and optimizing the codebase.
  • 🤓 Internal refactors: Refactoring the codebase to improve its structure and maintainability without changing its functionality.
  • 📓 Docs: Creating, updating, or improving documentation to help users understand and use Essential Eth more effectively.
  • 🧪 Tests: Writing, updating, and maintaining tests to ensure the reliability and stability of the Essential Eth codebase.

What issues should I start on first?

We have set up a GitHub project here for you to see all the issues by priority.🚀

Quick bootstrap

  • All versions of node 12 and higher are supported
# Install and build
npm install

# Run test suite
npm run test

GitPOAP

In partnership with GitPOAP, Essential ETH wants to recognize all contributors for their contributions toward the growth of this library. Developers can validate their contributions on Github and showcase their GitPOAP as proof-of-work toward their Web3 identity. 🔍💻


Alt


What is a GitPOAP?

GitPOAP is a contributor recognition platform built on top of the POAP Protocol (Proof of Attendance Protocol). Similar to a POAP, each GitPOAP represents a digital collectible. It serves as a badge of validation for the action taken by the individual. By serving as a bridge between Github and Web3, it allows repo maintainers to recognize contributors for their meaningful contributions. Learn more about GitPOAP, here.

How can I claim?

Here are two steps that you can take to qualify for a GitPOAP:

  1. Contribute to any open issue and submit a PR. Upon approval of PR merge, the GitPOAP will automatically be issued to the Github account. 🤝👩‍💻👨‍💻

  2. Head to gitpoap.io and connect your GitHub account to mint! 💰🔗