Skip to main content

Reward Guidelines

Introduction​

Welcome to the Conflux Contribution Reward Guidelines. Our mission is to build a robust, accessible, and community-driven platform, and your contributions are integral to achieving this vision. Whether you are an experienced developer, a technical writer, a first-time contributor, or simply an enthusiast, your insights, ideas, and improvements can make a significant impact. Understanding that every effort put toward enhancing the Conflux environment deserves recognition, we've implemented a reward system based on FansCoin (FC).

This article details how your contributions, categorized under 'Issues' and 'Pull Requests', are rewarded. You will learn how identifying problems or presenting enhancements in various aspects—ranging from formatting and readability to error identification—is rewarded. With your support, Conflux continues to evolve and improve by the day.

Guidelines​

Issues (16 ~ 80 FC)​

  • If the individual who raised the issue also offers a solution, the reward will be doubled. Here are some examples:
    • Formatting
      • Identifying spelling or grammar errors: 16 FC
      • Spotting broken links or obsolete details: 16 FC
      • Highlighting issues with code blocks or other format-related problems: 16 FC
      • Flagging issues with images, diagrams: 16 FC
    • Readability Enhancements
      • Proposing that existing explanations are unclear: 16 FC
      • Recommending improved descriptions for certain issues: 16 FC
      • Suggesting supplementary explanations for specific use-cases of features: 32 FC
      • Indicating lack of contextual information causing comprehension difficulties: 32 FC
      • Highlighting deficient tool/document links resulting in limited interactivity: 32 FC
      • Recommending creation or improvement of diagrams, charts, or visual aids: 32 FC
      • Requesting additional details on a specific topic: 48 FC
      • Proposing the development of new articles on particular Conflux topics: 48 FC
      • Suggesting a revamp of document structure: 48 FC
      • Recommending the creation of user guides for basic Conflux product use: 48 FC
    • Error Identification
      • Spotting errors in current explanatory concepts: 64 FC
      • Highlighting examples that fail: 64 FC
      • Identifying logical errors in code: 80 FC
      • Pinpointing inaccuracies in API document parameters that hamper utility: 80 FC
      • Identifying incorrect feature descriptors: 80 FC
      • Spotting technical inaccuracies in the documentation: 80 FC
      • Highlighting current governance shortcomings: Determined case by case.
    • Document Website Code Issues
      • Front-end layout issues: 32 FC.
      • Suggesting certain components for certain function: 48 FC.
      • Other issues: case by case.

Pull Requests (16 ~ 640 FC and much more)​

Most of the times, pull requests rewards is determined by the content and complexity. Please refer to rewards evaluation to see how the value will be determined.

  • It's desirable to always raise an issue prior to creating a pull request. If the pull request fully resolves an issue, the reward is at least equivalent to that of the issue, regardless of the effort involved.
  • If the originator of the pull request solves an issue they raised, they receive an extra 25% reward.
  • Examples include :
    • Formatting
      • Fixing spelling or grammar errors: 16 FC.
      • Updating broken links or outdated information: 16 FC.
      • Resolving issues with code blocks or other formatting: 32 FC.
      • Rectifying issues with images, diagrams: 64 FC.
    • Improvements
      • Providing better conceptual explanations: From 30 FC, up to 100 FC or more, determined by content and significance.
      • Proposing optimized descriptions for a problem: From 30 FC, up to 100 FC or more, determined by importance.
      • Adding explanations about specific feature use-cases: From 128 FC, up to 300 FC or more, determined by content and significance.
      • Providing added context to enhance understanding: From 128 FC, up to 300 FC or more, determined by content and significance.
      • Increasing interactivity through addition of tool, document links, etc.: From 64 FC, up to 300 FC or more, determined by content and significance.
      • Creating or improving visual aids like diagrams, charts: From 100 FC, up to 300 FC or more, determined by significance.
      • Providing detailed elaboration on a topic either by adding contents to a certain page or creating new articles: From 60 FC, up to 300 FC or more, determined by content and significance.
      • Crafting new articles on a Conflux-specific topic, depending on complexity and community need: 360 FC, potentially more.
      • Developing user guides for the basic usage of Conflux products: 360 FC, potentially more.
    • Error Resolution
      • Offering correct concept explanations: From 60 FC, up to 300 FC or more, determined by content and significance.
      • Providing correct example results: From 30 FC, up to 300 FC or more, determined by content and significance.
      • Providing correct codes: From 60 FC, up to 600 FC or more, determined by complexity and significance.
      • Correcting API document parameters: From 60 FC, up to 300 FC or more, depending on content and significance.
      • Providing accurate feature descriptions: From 60 FC, up to 300 FC or more, depending on content and significance.
      • Correcting technical inaccuracies in documentation: From 60 FC, up to 300 FC or more, depending on significance.
      • Proposing corrections for governance deficiencies: Determined on a case-by-case basis.
    • Document Website Improvements
      • Determined case-by-case

Rewards Evaluation and Examples​

As the rewards for pull requests are mostly determined case-by-case, we would like to let contributors know how rewards are evaluated.

  • Importance of the created contents. Here are contents we consider of higher significance
    • Conflux-specific contents
    • Contents developers are more likely to visit
    • Code/project examples ready to use out of the box
  • Complexity and efforts made on the pull request
    • More hours needed to complete the work (evaluated via content quality)
    • (Runnable) code attached
    • Higher techinical skill threshold
    • Visual aids attached

Several examples would be provided for reference:

Pull RequestGuideline
Floor Reward		Expected RewardContentWhy
PR#49480300*125%New article regarding reentrancy Attack+ important content (frequent security issue)
+ with code
+ resolving creator issue
+ new article stating clearly for the topc
PR#49380150*125%New article regarding circuit logic gas cost+ with code
+ resolving creator issue
+ new article stating clearly for the topic
- less important content (negative readability impact and less common in development)
PR#4733080Suggesting how to use confura api key+ important content(fixes)
PR #467-120*125%Improves website display for mobile devices+ front-end technique required
+ resolving creator issue
PR #425360640This PR creates+ conflux-specific content
+ with code illustration
+ detailed explanation as well as video tutorial
+ with projects ready to deploy out of the box
note

The Expected Reward serves as the evaluation of the FC to receive according to the latest reward guideline. However, as the creator might be our internal contributor or contribution guideline is changed, the actual reward distribution amount may vary.

How Rewards are Distributed​

We are tracking rewards with an internal table and results will be periodically revealed in Github discussions.

Regular Review of Reward Guidelines​

Please note that the reward guidelines are subject to review and possible changes every 3 months. This ensures that our guidelines remain relevant and effective in promoting and rewarding valuable contributions.

We look forward to your contributions and thank you for helping us improve our documentation site! If you have any questions or need assistance, please feel free to create an issue in our Github repo.