From 705b9ff1e57209267e57ccc183a3ea2260264b67 Mon Sep 17 00:00:00 2001 From: taniashiba <126204004+taniashiba@users.noreply.github.com> Date: Tue, 1 Oct 2024 11:22:31 -0400 Subject: [PATCH] Hacktoberfest 2024 MD Docs Update (#299) Co-authored-by: Tania Chakraborty --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 13 +++++++++++++ 2 files changed, 48 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95b8a6fa..d7243317 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,41 @@ There are many ways to be an open source contributor, and we're here to help you This guide is for you. +## πŸŽ‰ Hacktoberfest 2024 πŸŽ‰ + +`didpay` is a participating in Hacktoberfest 2024! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone. + +### Here's how you can get started: +1. Read the [code of conduct](https://github.com/taniashiba/didpay/blob/main/CODE_OF_CONDUCT.md). +2. Choose a task from this project's Hacktoberfest issues in our [Project Hub](https://github.com/TBD54566975/didpay/issues/298). Each issue has the 🏷️ `hacktoberfest` label. +5. Comment ".take" on the corresponding issue to get assigned the task. +6. Fork the repository and create a new branch for your work. +7. Make your changes and submit a pull request. +8. Wait for review and address any feedback. + +### πŸ† Leaderboard & Prizes +Be among the top 10 with the most points to snag custom swag just for you from our TBD shop! To earn your place in the leaderboard, we have created a points system that is explained below. As you complete tasks, you will automatically be granted a certain # of points. + +#### Point System +| Weight | Points Awarded | Description | +|---------|-------------|-------------| +| 🐭 **Small** | 5 points | For smaller tasks that take limited time to complete and/or don't require any product knowledge. | +| 🐰 **Medium** | 10 points | For average tasks that take additional time to complete and/or require some product knowledge. | +| πŸ‚ **Large** | 15 points | For heavy tasks that takes lots of time to complete and/or possibly require deep product knowledge. | + +#### Prizes +Top 10 contributors with the most points will be awarded TBD x Hacktoberfest 2024 swag. The Top 3 contributors will have special swag customized with your GitHub handle in a very limited design. (more info in our Discord) + + + +### πŸ‘©β€ Need help? +Need help or have questions? Feel free to reach out by connecting with us in our [Discord community](https://discord.gg/tbd) to get direct help from our team in the `#hacktoberfest` project channel. + +Happy contributing! + +--- + + ## Development Prerequisites ___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___ diff --git a/README.md b/README.md index af5d3cc7..1e10d3f3 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,19 @@ DIDPay is an open source mobile app that provides a way for individuals to interact with PFIs via tbDEX. Concretely, DIDPay provides a UI for individuals to interface with PFIs. +## πŸŽ‰ Hacktoberfest 2024 πŸŽ‰ + +`didpay` is a participating project in Hacktoberfest 2024! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone. + +### To get started: +1. Read the [contributing guide](https://github.com/TBD54566975/didpay/blob/main/CONTRIBUTING.md). +2. Read the [code of conduct](https://github.com/TBD54566975/didpay/blob/main/CODE_OF_CONDUCT.md). +3. Choose a task from this project's Hacktoberfest issues in our [Project Hub](https://github.com/TBD54566975/didpay/issues/298) and follow the instructions. Each issue has the 🏷️ `hacktoberfest` label. + +Have questions? Connecting with us in our [Discord community](https://discord.gg/tbd) in the `#hacktoberfest` project channel. + +--- + ## Local Development ### Prerequisites