# 平台赞赏

可通过赞赏功能，向那些帮助过你的、你欣赏的项目或用户提供资金鼓励。

CNB 的赞赏功能连接平台用户与创作者的微信赞赏码，平台将在合适位置展示赞赏码信息。

用户扫码后的赞赏资金直接进入微信赞赏码，CNB 不收取任何处理费用。

赞赏前请注意甄别创作者发布的信息，确认可信。

## 上传赞赏码

1. 生成微信赞赏码<br />

前往个人微信，右上角＋ -> 收付款 -> 点击赞赏码，完成赞赏设置后保存赞赏码<br />

![wechat-sponsor](https://docs.cnb.cool/images/wechat-sponsor.png)
2. 上传微信赞赏码<br />

前往 CNB 平台-个人设置，上传刚刚生成的微信赞赏码。

## 展示赞赏码

### 个人主页

访问用户主页时，若用户上传了赞赏码，则点击赞赏按钮即可查看赞赏码，微信扫码赞赏。

### 代码仓库首页

访问仓库首页时，默认将展示过去 30 天仓库贡献度 Top5 用户的赞赏信息。

若用户没有上传赞赏码则不展示该用户，且**不递补**排名更低的用户。

仓库贡献度综合用户参与的 Commit、Pr、Issue 等仓库活动计算得出。

## 自定义仓库赞赏信息

如果需要自定义仓库的赞赏用户名单，或自定义捐赠链接，可在默认分支添加 `.cnb/FUNDING.yml` 文件。

文件内容：

```yaml
# 指定赞赏用户，填写用户名，最多取前 5 个用户。配置后将仅展示指定用户，不再展示仓库贡献度 Top5 用户。
cnb:
  - user1
  - user2
# 自定义捐赠链接，可在赞赏区域展示捐赠链接信息，最多取前 5 个 URL。
custom:
  - custom-url1
  - custom-url2
```

## 停止接受赞赏

个人赞赏信息：前往个人设置，删除赞赏码即可。

若配置了捐赠链接，需前往仓库删除 `.cnb/FUNDING.yml` 中的赞赏信息。