跳到主要内容

奖励准则

简介

欢迎来到 Conflux 贡献奖励准则。 我们的使命是建立一个强大、可访问且由社区驱动的平台,而您的贡献对于实现这一愿景至关重要。 无论您是经验丰富的开发者、技术撰稿人、首次贡献者还是简单的爱好者,您的见解、想法和改进都能产生重大影响。 我们深知每一份为增强Conflux环境所做的努力都值得认可,因此我们已经实施了基于FansCoin(FC)的奖励制度。

This article details how your contributions, categorized under 'Issues' and 'Pull Requests', are rewarded. 您将了解如何通过发现问题或做出对不同方面的完善——从格式和可读性到错误识别——来获得奖励。 With your support, Conflux continues to evolve and improve by the day.

准则

问题奖励准则

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.

  • 格式问题
    • 发现拼写或语法错误:16 FC
    • 发现失效链接:16FC
    • 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).
  • 发现错误
    • 指出产品信息需要更新:32 FC。
    • 发现技术或概念细节方面的错误或不准确的信息:80 FC。 这包括:
      • 描述问题:概念解释、API 文档参数、功能特性等。
      • 代码问题:要求能够在通用或特定平台上复现,包括失败的示例代码、意外的代码输出、失败的命令等。
  • Suggesting Improvements
    • 建议对某些主题进行完善,以简化理解或提供更多细节:根据问题的重要性及是否提出解决方案(不一定是拉取请求),奖励从 32 FC 到 64 FC 不等。 这包括:
      • 指出解释的模糊之处
      • 建议增加或完善图表、图解或视觉辅助工具
      • 指出缺乏背景信息(解释或示例),导致描述难以理解
      • 指出对功能的描述不够详细,如缺乏实现方法或对极端情况的讨论
    • 建议增加针对特定主题的新文章:根据问题的重要性,奖励从 32 FC 到 64 FC 不等。
    • 建议改进文档结构:对有价值但不一定被接受的解决方案给予 32 FC,若被接受则给予 64 FC。 注意:我们将仔细考虑这些问题。
    • 指出当前治理方面的不足之处:奖励视情况而定。
  • 文档页面代码问题
    • 前端样式问题:包括布局、字体大小、行间距等:48 FC,若有解决方案(不一定是拉取请求)给予 96 FC
    • 建议针对特定功能引入特定组件:96 FC。
    • 其他问题:根据具体情况确定。

拉取请求奖励指南

拉取请求的奖励值主要由内容的复杂度和重要性决定。 具体的评估方法,请参考 奖励评估

  • 如果拉取请求的发起者解决了他们提出的问题,将额外获得 25% 的奖励。
  • 格式问题:
    • 修复拼写或语法错误:16 FC
    • 更新失效链接:16 FC。
    • 解决代码块格式等格式相关问题:32 FC
    • 修正图像、图表的格式问题:64 FC。
  • 解决错误
    • 更新过时的产品信息:64 FC,最高可达 128 FC 或更多,具体由内容和重要性决定。
    • 提供正确的解释:如解释性概念、API 文档参数、功能特性等:从 64 FC 开始,最高可达 128 FC 或更多,具体由内容和重要性决定。
    • 纠正代码相关错误:要求能够在通用或特定平台上复现,包括失败的示例代码、意外的代码输出或失败的命令:从 64 FC 开始,最高可达 320 FC 或更多,具体由内容和重要性决定。
  • 改进
    • Improvements relating to issues with LONG TERM label, for example, adding glossaries, article labels, article keywords, etc: From 32 FC, determined by content and significance.
    • 对某些主题进行完善以易于理解,例如提供更清晰的解释或增加示例:从 32 FC 开始,最高可达 128 FC 或更多,具体由内容和重要性决定。
    • 添加或完善视觉辅助工具,如图表、图解:从 128 FC 开始,最高可达 256 FC 或更多,具体由内容和重要性决定。
    • 添加对功能或主题的详细描述,如实现方法或极端情况分析:从 80 FC 开始,最高可达 320 FC 或更多,具体由内容和重要性决定。
    • 编写关于某个主题的新文章:根据复杂度和社区需求,从 128 FC 开始,最高可达 640 FC,具体由内容和重要性决定,对于非常出色的文章可能更多。
      • 如果文章涉及常见概念或开发实践,奖励通常在 128 FC 到 320 FC 之间。
      • 如果文章主题是 基于 Conflux 的,或文章为开发指南,奖励将在 320 FC 到 640 FC(甚至更高)之间。
    • 编写 Conflux 产品的用户手册:320 FC,最高可达 480 FC 或更多,具体由内容和重要性决定。
  • 文档页面改进
    • 最低 96 FC,具体由任务复杂度决定。

奖励评估方法与示例

拉取请求的奖励通常由具体情况而决定,我们认为将这些奖励的评估思想清晰地告知贡献者是非常重要的。

  • 创建新内容具有重要的意义。 我们尤其重视以下类型的内容:
    • 特定于 Conflux 的内容
    • 对开发者更有帮助的内容
    • 附带现成代码示例的开发教程
  • 拉取请求的复杂度及投入的努力也会影响奖励:
    • 创建内容所需的时间更长(基于内容质量评估)
    • 需要更高的技术技能或理解
    • 清晰的解释,比如像代码片段或视觉辅助工具

下面提供几个参考示例:

拉取请求基础奖励预期奖励贡献内容评判标准
PR#494128320*125%关于重入攻击的新文章- 内容重要(常见的安全问题)
+ 包含代码示例
+ 解决了创建者提出的问题
+ 对主题提供了清晰的解释
PR#493128196*125%New article on circuit logic gas cost* 包含代码
+ 解决了创建者提出的问题
+ 对主题提供了清晰的解释
- 内容较为次要
PR#4733280建议使用 Confura API 密钥- 为经常使用的内容增加了清晰度
+ 增加了经常使用的内容
PR #46796150*125%改进了网页在移动设备上的显示* 需要前端技术
+ 解决了创建者提出的问题
PR #425320640提供了一个即插即用的 eSpace 开发示例项目- 是特定于 Conflux 的内容
+ 包含代码演示
+ 提供了详细的解释和视频教程
+ 提供了一个开箱即用的项目
备注

“预期奖励”是根据我们 最新 的奖励准则预估的贡献者可能收到的 FC 数额。 然而,请注意实际的奖励金额可能会有所不同。 这种变化可能是因为贡献者是我们团队的内部成员,或者是由于贡献指南已经产生了更改。

奖励发放过程

我们使用内部的 Notion 表格追踪奖励,结果将定期在我们的 Github 讨论 中发布。

奖励定期发放,至少每三个月一次。 我们旨在精简我们的工作流程,以缩短这一时间间隔。

奖励准则定期审查

值得一提的是,每一轮奖励发放后,我们的奖励准则都会进行审查,并可能进行修订。 这确保了我们的准则可以处于最新版本,并能够准确地对有用的贡献做出鼓励与奖励。

我们非常感谢您的贡献及对我们的文档网站做出的改善! 如果您有任何疑问或需要帮助,请不要犹豫并在我们的 Github 仓库中创建一个问题。