Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

regular review of reward guideline #508

Merged
merged 4 commits into from
Apr 11, 2024
Merged

regular review of reward guideline #508

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b97c3a
regular review of reward guideline
darwintree Apr 3, 2024
95953f2
Simplify and clarify reward guidelines
darwintree Apr 8, 2024
4a26e2d
Improve language
darwintree Apr 8, 2024
638feeb
Update reward-guidelines.md
darwintree Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 92 additions & 66 deletions docs/general/CONTRIBUTING/reward-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,70 +13,96 @@ This article details how your contributions, categorized under 'Issues' and 'Pul

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

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

* 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: From 60 FC, up to 300 FC or more, determined by content and significance.
* Crafting new articles on a Conflux topic, depending on complexity and community need: 300 FC, potentially more.
* Developing user guides for the basic usage of Conflux products: 300 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.

## How Rewards are Distributed

Dework will be used to track rewards history and we will distribute rewards once a quarter. Just [join our Dework space](https://app.dework.xyz/conflux/developer-portal-1958) if you are willing to receive FC rewards for your contribution.

## 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.
### Issues Reward Guidelines

Creating issues is an excellent way for us to understand the needs of the community and identify areas for improvement. Issues created will be tagged as either `ACCEPTED` or `REJECTED`, indicating our assessment of whether the content is suitable for further action.

* **Formatting**
* Identifying spelling or grammar errors: 16 FC
* Spotting broken links: 16 FC
* Highlighting issues with code blocks, localization or other format-related problems: 32 FC
* Flagging **format** issues with images, diagrams: 24 FC, or 48 FC if a solution is proposed (not necessarily a pull request).
* **Error Identification**
* Spotting outdated product information: 32 FC.
* Discovering errors or incorrect information about technical or conceptual details: 80 FC. This encapsulates
* Issues with descriptions, such as explanatory concepts, API document parameters, characteristics of features, and so forth.
* Issues with code that can be reproduced on a general or specific platform, including failing sample code, unexpected code output, or failing commands.
* **Suggesting Improvements**
* Recommending enhancements to certain topics to simplify understanding or provide more detail: From 32 FC to 64 FC depending on the issue significance and whether a solution is proposed (not necessarily a pull request). This encapsulates
* Highlighting unclear explanation
* Recommending creation or improvement of diagrams, charts, or visual aids
* Highlighting insufficient contextual information (explanations or examples) leading to comprehension issues
* Indicating a lack of detailed description of a feature, such as implementation or edge cases.
* Proposing the development of new articles on particular topics or product: From 32 FC to 64 FC depending on the issue significance.
* Suggesting improve the document structure: 32 FC for *valuable*, but not necessarily ACCEPTED solutions, or 64 FC if accepted. NOTE: We will carefully consider these issues.
* Highlighting current governance shortcomings: Determined case by case.
* **Document Website Code Issues**
* Front-end style issues including layout, font size, line spacing, etc: 48 FC, or 96 FC with a suggested solution (not necessarily a pull request)
* Recommending specific components for certain functions: 96 FC.
* Other issues: Determined case by case.

### Pull Requests Reward Guidelines

Reward values for pull requests are primarily determined by the complexity and significance of the content. Please refer to [rewards evaluation](#rewards-evaluation-and-examples) for more details on value determination.

* If the originator of the pull request solves an issue they raised, an additional reward of 25% is granted.
* **Formatting**:
* Fixing spelling or grammar errors: 16 FC.
* Updating broken links: 16 FC.
* Resolving issues with code blocks or other formatting: 32 FC.
* Rectifying formatting issues with images, diagrams: 64 FC.
* **Error Resolution**
* Updating outdated product information: 64 FC, up to 128 FC or more, determined by content and significance.
* Offering correct explanations, such as explanatory concepts, API document parameters, characteristics of features, and so forth: From 64 FC, up to 128 FC or more, determined by content and significance.
* Correcting code-related errors, which can be reproduced on a general or specific platform, including failing sample code, unexpected code output, or failing commands: From 64 FC, up to 320 FC or more, depending on content and significance.
* **Improvements**
* Enhancements to certain topics to simplify understanding, e.g. providing clearer explanation or added examples: From 32 FC, up to 128 FC or even more, determined by content and significance.
* Creating or improving visual aids like diagrams, charts: From 128 FC, up to 256 FC or more, determined by content and significance.
* Adding lacked details of a feature or a topic, such as implementation or edge cases: From 80 FC, up to 320 FC or even more, determined by content and significance.
* Crafting new articles on certain topic, depending on complexity and community need: From 128 FC, up to 640 FC, determined by content and significance, potentially more for tremendous articles.
* if the article is about general concept or development practice, the reward will typically range from 128 FC to 320 FC.
* if the topic is **Conflux-specific** or the article is a development guide, the reward will range from 320 FC to 640 FC (or even higher).
* Crafting user guides for the basic usage of Conflux products: 320 FC, up to 480 FC or more, determined by content and significance.
* **Document Website Improvements**
* With a minimum of 96 FC, determined case-by-case based on task complexity.

#### Rewards Evaluation and Examples

With pull request rewards often being determined on a case-by-case basis, we believe it's important to provide contributors with a clear understanding of how these rewards are assessed.

* The significance of the content that has been created. In particular, we regard the following types of content as being of greater importance:
* Content specific to Conflux
* Content that developers are more likely to visit
* Development tutorials accompanied by ready-to-use code examples
* The complexity of the pull request along with the effort invested also affect the reward:
* Content that required more time to create (evaluated based on content quality)
* Higher technical skills or understanding required
* Clear explanation, e.g., inclusion of code snippets or visual aids

Several examples are provided below for your reference:

| Pull Request | Guideline Base Reward| Anticipated Reward | Content| Justification |
|-|-|-|-|-|
|[PR#494](https://github.com/Conflux-Chain/conflux-documentation/pull/494)|128| 320*125% |New article on reentrancy attack|+ Significant content (common security issue) <br/> + Includes code sample <br/> + Resolves issue raised by creator <br/> + Provides clear explanation on the topic|
|[PR#493](https://github.com/Conflux-Chain/conflux-documentation/pull/493)|128| 196*125% |New article on circuit logic gas cost|+ Includes code <br/> + Resolves issue raised by creator <br/> + Provides clear explanation on the topic <br/> - Content of less importance|
|[PR#473](https://github.com/Conflux-Chain/conflux-documentation/pull/485)|32| 80 | Suggests usage of Confura API key |+ Provides important clarification <br/> + Adds to frequently used content|
|[PR #467](https://github.com/Conflux-Chain/conflux-documentation/pull/467)|96| 150*125% | Improves website display for mobile devices |+ Requires front-end technique <br/> + Resolves issue raised by creator|
|[PR #425](https://github.com/Conflux-Chain/conflux-documentation/pull/425)|320|640 | Offers an out-of-the-box sample project for eSpace development |+ Is Conflux-specific content <br/> + Includes code demonstration <br/> + Provides a detailed explanation and video tutorial <br/> + Offers a ready-to-use project out of the box |

:::note

The 'Anticipated Reward' is an estimated figure of the FC that contributors might receive, according to our **most recent** reward guidelines. However, please keep in mind that the actual reward amount may vary. This variation could be due to the contributor being an internal member of our team, or due to changes made to our contribution guidelines.

:::

## Reward Distribution Process

We track rewards using an internal Notion table and the results will be regularly posted in our [Github discussions](https://github.com/Conflux-Chain/conflux-documentation/discussions).

Rewards are distributed on a regular basis, at least once every three months. We aim to refine our workflow to reduce this interval over time.

## Regular Evaluation of Reward Guidelines

It's important to note that our reward guidelines are reviewed, and potentially revised, after each round of reward distribution. This ensures that our guidelines remain up-to-date and effective in encouraging and rewarding useful contributions.

We greatly appreciate your contributions and thank you for aiding us in enhancing our documentation site! If you have any queries or require support, please don't hesitate to open an issue in our Github repository.