Skip to content

Commit

Permalink
📓adding contribution doc (#214)
Browse files Browse the repository at this point in the history
* adding contribution doc

* fixing readme

* adding contribution link to the readme

* last fix I swear

* Update readme.md

* Update readme.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
  • Loading branch information
jtfirek authored May 8, 2023
1 parent 81e534e commit 69cec04
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 27 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 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](https://github.com/dawsbot/essential-eth/projects/1) for you to see all the issues by priority.🚀

## 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. 🔍💻

<br/>

![Alt](https://www.gitpoap.io/_next/image?url=https%3A%2F%2Fassets.poap.xyz%2Fgitpoap3a-2023-essential-eth-contributor-2022-logo-1670961141021.png&w=750&q=75)

<br/>

#### 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](https://www.gitpoap.io/).

#### How can I claim?

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

1. Contribute to [any open issue](https://github.com/dawsbot/essential-eth/issues) 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! 💰🔗
32 changes: 5 additions & 27 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,8 @@
- [More Info](#more-info)
- [Identical vs Similar vs Dissimilar {&#035;isd}](#identical-vs-similar-vs-dissimilar-isd)
- [Miscellaneous](#miscellaneous)
- [GitPOAP](#gitpoap)
- [What is a GitPOAP?](#what-is-a-gitpoap)
- [How can I claim?](#how-can-i-claim)
- [What issues should I start on first?](#what-issues-should-i-start-on-first)
- [Contributing](#Contributing-and-GitPOAP)
- [Contributing Guidelines Doc](CONTRIBUTING.md)

</details>

Expand Down Expand Up @@ -1585,28 +1583,8 @@ Note: In `web3.js`, almost every method or function can be passed a callback. `e
- [📓 View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)
- [📋 View our project board](https://github.com/dawsbot/essential-eth/projects/1)

### GitPOAP
## Contributing and 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.
We welcome and appreciate all contributions to Essential Eth! If you're interested in helping us improve this library, please read our [Contributing Guidelines](CONTRIBUTING.md) to understand the types of contributions we're looking for and the process of making them.

<br/>

![Alt](https://www.gitpoap.io/_next/image?url=https%3A%2F%2Fassets.poap.xyz%2Fgitpoap3a-2023-essential-eth-contributor-2022-logo-1670961141021.png&w=750&q=75)

<br/>

#### 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](https://www.gitpoap.io/).

#### How can I claim?

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

1. Contribute to [any open issue](https://github.com/dawsbot/essential-eth/issues) 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!

#### What issues should I start on first?

We have set up a GitHub project [here](https://github.com/dawsbot/essential-eth/projects/1) for you to see all the issues by priority.
In partnership with GitPOAP, Essential ETH wants to recognize **all** contributors for their contributions toward the growth of this library. More information about GitPOAP can be found on the [Contributing Guidelines](CONTRIBUTING.md#GitPOAP).

0 comments on commit 69cec04

Please sign in to comment.