Skip to content

Commit

Permalink
Add Developer Contributor Program Landing Page
Browse files Browse the repository at this point in the history
  • Loading branch information
@owans
owans committed Oct 10, 2024
1 parent b273388 commit 8c4a590
Show file tree
Hide file tree
Showing 2 changed files with 187 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ All contributions are welcome, including issues, updates and tweaks, blog posts,
## How to Contribute
If you are worried or don’t know where to start, check out the next section that explains what kind of help we could use and where you can get involved.

You can send your questions on [Discord](http://discord.gg/rootstock), send a [Pull Request](https://github.com/rsksmart/rsksmart.github.io/pulls) or [Submit an Issue](https://github.com/rsksmart/rsksmart.github.io/issues), and a maintainer will attend to it.
You can send your questions on [Discord](http://discord.gg/rootstock), send a [Pull Request](https://github.com/rsksmart/devportal/pulls) or [Submit an Issue](https://github.com/rsksmart/devportal/issues/new/choose), and a maintainer will attend to it.

### Reporting Bugs

1. **Check for Existing Issues**: Before reporting a bug, please check the [issue tracker](https://github.com/rsksmart/rsksmart.github.io/issues) to see if it has already been reported.
1. **Check for Existing Issues**: Before reporting a bug, please check the [issue tracker](https://github.com/rsksmart/devportal/issues/) to see if it has already been reported.
2. **Create a New Issue**: If your issue is not listed, create a new one. Provide as much detail as possible:
- A clear and descriptive title.
- Steps to reproduce the bug.
Expand All @@ -21,7 +21,7 @@ You can send your questions on [Discord](http://discord.gg/rootstock), send a [P

### Suggesting Features

1. **Check for Existing Requests**: Look through the [issue tracker](issues) to see if someone else has suggested the feature.
1. **Check for Existing Requests**: Look through the [issue tracker](https://github.com/rsksmart/devportal/issues/) to see if someone else has suggested the feature.
2. **Create a New Feature Request**: If the feature is not listed, open a new issue. Include:
- A clear and descriptive title.
- The motivation for the feature.
Expand Down
184 changes: 184 additions & 0 deletions docs/04-resources/02-contribute/dev-contributor.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
---
sidebar_label: Developer Contributor Program
sidebar_position: 4
title: 🌱 Rootstock Developer Contributor Program 💻
description: "The Rootstock Developer Contributor Program allows developers to contribute to Rootstock by contributing code or creating educational content. You get to support the platform at your own pace, and every eligible contribution is rewarded in RIF based on its impact and complexity."
tags: [rootstock, rsk, code, resources, content, developer contributor program, writing]
---

Welcome to the Rootstock Developer Contributor Program! This program is designed for developers who want to contribute to the Rootstock ecosystem while earning RIF rewards for their valuable contributions.

## 🌟 What is it?

The Rootstock Developer Contributor Program allows developers to contribute to Rootstock by contributing code or creating educational content. You get to support the platform at your own pace, and every eligible contribution is rewarded in RIF based on its impact and complexity.

## ✔️ General Contribution Criteria
* Quality: Contributions must be valuable to the Rootstock ecosystem, whether improving functionality, enhancing usability, or educating developers and community members.
* Originality: All work should be original and created by you. Translations or adaptations should remain true to the source material.
* Relevance: Contributions must directly benefit Rootstock’s developer community and ecosystem.
* Accuracy: Code, tutorials, and other technical content must be precise and technically correct.

## 🎁 Rewards
Contributions will be rewarded in RIF based on the value and impact they bring to the Rootstock developer community, following the specifications below for each category.

## 💡 Types of Developer Contributions Accepted

### Code Contributions 🛠️

**What you can contribute:**

Developers are encouraged to leverage the developer portal reference use-case projects to make meaningful contributions to the Rootstock ecosystem. See the options below:

<Accordion>
<Accordion.Item eventKey="0">
<Accordion.Header as="h3">1. Meme Token Launchpad</Accordion.Header>
<Accordion.Body>
Learn more about this project in this [video](https://drive.google.com/file/d/1L6f2nQrhMe0fFFAUZYaengg49TnWtprN/view) or on [Meme Token Launchpad Blog](https://docs.google.com/document/d/1viThMi9WagcAyQFRMYwuqSgYa8hdY2gTr51iI_c1EWI/edit#heading=h.lctlajfmoxe2). [Add link to Repo]
**Contribution Options:**
* Token Creation: Develop an ERC-20 token with essential parameters such as name, ticker, and logo.
* Additional Minting Parameters: Implement extra minting options.
* Burn Mechanisms: Define and implement token burn mechanisms to increase scarcity or reward holders.
* Pump Fun Platform: Build a platform to showcase and hype newly launched tokens, creating an engaging environment for degens and creators.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="1">
<Accordion.Header as="h3">2. RUNES & MEME Giveaway Engine: A Tool for Token Airdrops</Accordion.Header>
<Accordion.Body>
Learn more about this project on [RUNES & MEME Giveaway Engine: A Tool for Token Airdrops Blog](https://docs.google.com/document/d/1rLXpTlrRycwGXb5CmJpR35jVHuH6FHJASy6HgVwjmXw/edit#heading=h.wnuc8ula73zx). [Add link to Repo]
**Contribution Options:**
* Set Up a Token Airdrop: Implement airdrops of ERC-20 tokens or RUNES.
* Staking-Based Eligibility: Add rules to reward users who have staked tokens in another protocol, encouraging broader ecosystem participation.
* On-Chain Activity: Create rules to distribute tokens based on on-chain actions like interacting with a contract or voting on a proposal.
* Holdings-Based Eligibility: Reward users based on the number of tokens they hold, incentivizing loyalty and long-term engagement.
* RNS Domain Criteria: Airdrop tokens to users who own specific RNS domains, adding a unique layer to community interaction.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="2">
<Accordion.Header as="h3">3. Voting Scoreboard</Accordion.Header>
<Accordion.Body>
Learn more about this project on Voting Score Board Blog. [Add link to Repo]
**Contribution Options:**
* ERC-20 Token Voting: Set up ERC-20 tokens for voting, allowing users to vote on proposals or choices within a project.
* Leaderboard Display: Track voter participation making it easy to highlight the most engaged community members.
* On-Chain Identity Integration: Incorporate RNS domains or other on-chain identities for personalized leaderboards.
* Graphical Representations: Add charts or graphs to visualize leaders' positions over time.
* Positional Changes: Display how participants' rankings shift daily or weekly, providing transparency in voting dynamics.
* Countdown Timer: Include a countdown feature to indicate when the voting period ends, creating a sense of urgency for participants.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="3">
<Accordion.Header as="h3">4. CLI (Developer Tooling)</Accordion.Header>
<Accordion.Body>
Learn more about this project on [CLI Tooling Blog](https://docs.google.com/document/d/1k8Qq10LnZtOckTBzE1QNSmUCYlFQBQcdlVWpOBy7H_Q/edit). [Add link to Repo]
**Contribution Options:**
* Create Wallets: Quickly set up new wallets and manage new addresses.
* Check Balances: Implement features to easily check balances for any address on Rootstock.
* Send Transactions: Simplify sending transactions with built-in commands.
* Deploy Contracts: Deploy smart contracts directly through the CLI.
</Accordion.Body>
</Accordion.Item>
</Accordion>

#### 👉Criteria:

For a comprehensive overview of the evaluation and reward system for code contributions, including detailed criteria for complexity, project impact, tests, and documentation, please refer to [Criteria for Developer Contributor Program](https://docs.google.com/document/d/1vWYWdWxSXUcTxNS_OlRikfEwmPSXgw3iDsQ-UAqheMw/edit). These criteria outline how contributions, ranging from simple fixes to advanced features or external integrations, will be assessed and rewarded, ensuring a balanced and fair approach to valuing developer participation and impact. This document covers everything from optimizing performance to integrating external APIs, with rewards adjusted based on the value and complexity of each contribution.

#### 👉Rewards:
1. Option A → 735 - 1470 RIF
2. Option B & C → 1475 - 3675 RIF
3. Option D, E & F → 3675 - 12265 RIF

### Educational Content 📝

**What you can contribute**
You can submit your drafts for blog posts, tutorials, guides, and videos on the following Rootstock themes:

<Accordion>
<Accordion.Item eventKey="0">
<Accordion.Header as="h3">1. Smart Contract Development Tutorials</Accordion.Header>
<Accordion.Body>
Writing, testing and deploying smart contracts on the Rootstock network.
* **Contribution Options:**
* Step-by-step guides on creating various types of smart contracts (e.g., tokens, DeFi, wallets, swaps, RWAs, NFTs, Runes, Ordinals, indexing, interoperability).
* Explaining Rootstock's unique features and how they can be utilized in smart contract development.
* Debugging and troubleshooting common issues in smart contract development.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="1">
<Accordion.Header as="h3">2. Integration with Rootstock and Ecosystem Solutions</Accordion.Header>
<Accordion.Body>
Demonstrating how to use and integrate tools with Rootstock compatible tools and libraries.
* **Contribution Options:**
* Explaining the concept of a sidechain and how Rootstock utilizes it.
* Step-by-step guides on integrating wallets, SDKs, or APIs with Rootstock applications.
* Step-by-step guides on using ecosystem dApps - refer to the “Building DeFi on Bitcoin” series on the Rootstock blog.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="2">
<Accordion.Header as="h3">3. Use Case Specific Guides – Case Studies and Real-World Examples</Accordion.Header>
<Accordion.Body>
Sharing real-world examples of Rootstock applications and use cases.
* **Contribution Options:**
* Building cross-platform or no-code dApps (e.g., mobile app development using Flutter, etc).
* Showcasing real-world applications on Rootstock.
* Building cross-chain applications, data indexing, etc., using partner tools and integrations.
* Porting dApps to Rootstock from other ecosystems
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="3">
<Accordion.Header as="h3">4. Tools and Libraries</Accordion.Header>
<Accordion.Body>
Introducing and explaining various tools and libraries that can be used for Rootstock development.
* **Contribution Options:**
* Tutorials on using popular development environments (e.g., Remix, Hardhat, Slither, Viem).
* Explaining the use of testing frameworks and libraries for smart contract testing.
* Demonstrating how to use debugging tools to identify and fix issues in Rootstock applications.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="4">
<Accordion.Header as="h3">5. Advanced Topics and Best Practices</Accordion.Header>
<Accordion.Body>
Expanding into more complex aspects of Rootstock development and sharing best practices.
* **Contribution Options:**
* Exploring complex concepts and how they enhance scalability on Rootstock.
* Discussing security considerations in smart contract development and best practices to avoid vulnerabilities.
* Exploring advanced topics like decentralized finance (DeFi), Runes, Ordinals, BITVMX, and their potential applications on Rootstock.
</Accordion.Body>
</Accordion.Item>
</Accordion>

#### 👉Criteria:

1. Educational content should be targeted towards developers looking to build on Rootstock or understand its integration with Bitcoin.
2. Blogs, tutorials (written or video), and developer guides should be original, accurate, and provide actionable insights.
3. Content must help other developers navigate and work with Rootstock, deploy smart contracts, use compatible tools, SDKs and libraries, and or integrate protocols on Rootstock.

> For a comprehensive overview of the evaluation and reward system for content contributions, including detailed criteria for depth, completeness, technical accuracy, educational value, and innovation, please refer to the [Evaluation Criteria for Content Contributions](https://docs.google.com/document/d/1vA3QK8ZNv5Fgegb0Jv2f03IVIREePDi4lrFE1vsfK7c/edit). These criteria outline how contributions, ranging from short introductory posts to in-depth tutorials and advanced case studies, will be assessed and rewarded, ensuring a balanced and fair approach to valuing content quality and impact. This document covers everything from word count appropriateness and inclusion of code examples to technical correctness and relevance to the Rootstock ecosystem, with rewards adjusted based on the value and complexity of each contribution.
#### 👉Guidelines:
* Follow the [Rootstock Style Guide](https://github.com/rsksmart/devportal/blob/main/STYLE-GUIDE.md)
* See [Contributing to Rootstock Documentation](https://github.com/rsksmart/devportal/blob/main/CONTRIBUTING_DOCS.md) and [Contributor Guidelines](https://github.com/rsksmart/devportal/blob/main/CONTRIBUTING.md)

#### 👉Rewards:
1. Blog Post: 735 - 1470 RIF
2. Tutorials (written): 1475 - 3675 RIF
3. Tutorial Videos: 2450 - 6130 RIF

## 📤 Developer Submission Process
1. Submitting your contributions is easy! Just follow these steps:
2. Complete Your Work: Whether it’s code or educational content, make sure it’s polished and meets the contribution criteria.
* Submit Through Google Form: Use this form link to submit your contribution. You’ll be asked to provide:
* Your name or pseudonym.
* Email address
* Your wallet address
* The type of contribution (code, content, etc.).
* A brief description of your work.
* A link to your submission (e.g., GitHub for code, file upload for blogs/tutorials).
* Workshop proposals should include an outline of the content and objectives.
3. Review: Your submission will be reviewed by Rootstock experts. You may be asked to make revisions or provide more information.
4. Earn RIF Rewards: Once approved, your contribution will be rewarded with RIF based on the impact and complexity of your work.

This program is your chance to make a meaningful impact on Rootstock while earning RIF. Ready to contribute? Submit your work and be a part of the Rootstock developer community! 🌍



0 comments on commit 8c4a590

Please sign in to comment.