向魔趣开源项目提交力所能及的贡献,让众人铭记你的付出 -【零基础文档,任何人都学得会】

<%= @topic_view.topic.title %>
<%= @topic_view.topic.average_rating %> <%= @topic_view.topic.posts.count { |p| !!p.custom_fields['rating'] } %>

我能为魔趣开源项目做什么?

如果你是程序员,你可以改进代码、修复故障或开发新颖的功能。
如果你没有任何开发基础,你可以帮助我们维护各个设备的基础信息与资源数据。

准备工作:

一、 注册账号
魔趣开源项目使用 Google 开发的 Gerrit Code Review 代码审查系统来实现团队协作开发。
因此,你先要拥有 MoKee Gerrit Code Review 账号。
我们的账户系统采用 OAuth2.0OpenID 认证方式,因此,你可以通过 GoogleGitHub 或是其它支持 OpenID 的提供商直接登陆我们的代码审查系统。

以下以注册 GitHub 账号为例:

  1. 访问 GitHub 注册页面 https://github.com/join
  2. 填写注册信息完成创建
  3. 前往你的邮箱管理后台,收取 GitHub 验证邮件,并完成验证

二、 登陆 MoKee Gerrit Code Review

  1. 访问 MoKee Gerrit Code Review 登陆页面 https://mokeedev.review/login
  2. 点击通过 GitHub 账号登陆
  3. 允许魔趣开源项目访问你的GitHub账号公共数据
  4. MoKee Gerrit Code Review 的设置中阅读并接受我们的开发者协议


三、 安装并配置相关工具 - Windows

  1. 我们的代码仓库使用 Git 管理,请访问 https://git-scm.com/ 下载并安装。
  2. 在你的工作目录单击鼠标右键,选择 Git Bash Here
  3. 配置你的 Git 用户、邮箱信息
    请注意填写自己的邮箱地址和 MoKee Gerrit Code Review 用户名
    git config --global user.email "demo@mokeedev.com"
    git config --global user.name “demo-mokee”
    git config --global review.mokeedev.review.username “demo-mokee”

  4. 生成 SSH key
    请注意填写自己的邮箱地址
    输入下面的命令并一路回车直到显示此界面
    ssh-keygen -t rsa -b 4096 -C "demo@mokeedev.com"
  5. SSH Key 添加到MoKee Gerrit Code Review
    输入下面的命令获取 SSH Key 后选中,单击右键点击复制到剪切板
    cat ~/.ssh/id_rsa.pub

    访问 https://mokeedev.review/settings/#SSHKeys 粘贴并点击添加

选择一个仓库提交贡献:

以下以添加小米 Mix 3 最新底层包为例:

  1. 魔趣的所有设备基础信息与资源数据存储在 MoKee/android_external_mokee_ServerController 仓库,请先复制页面中提供的命令将该仓库下载到本地。

    请注意不要照抄命令,每个人的账户不同,命令不同,以页面中显示的为准。
  2. 打开仓库中的extra.json文件并添加底包信息并保存文件
    请在修改前确认文件中是否中有你设备代号的节点,如果没有,请按照设备代号的首字母顺序来插入。如果有,请直接在该节点添加信息。
  3. 在仓库目录打开Git Bash 并填写提交数据,注意填写自己的设备代号,别照抄。
    git commit -a -m"device-info: update perseus's radio"
  4. 输入以下命令提交到 MoKee Gerrit Code Review
    git push origin HEAD:refs/for/master
  5. 访问 https://mokeedev.review/q/status:open 查看你的提交并等待其它开发者审查,如果你的贡献提交被开发者通过,你的贡献将会记录在 魔趣ROM 的 设置 - 关于手机 - 贡献者界面中。
  6. 恭喜你,这是你为魔趣做出的第一个贡献,我们无限期待你有更佳的表现!

写在最后

  1. 如果你是开发者,你可以访问 https://mokeedev.review/admin/repos 为任意仓库提交贡献
  2. 如果你没有任何开发基础,你可以修改 MoKee/android_external_mokee_ServerController 帮助我们完善各个设备基础信息与资源数据,包括但不限于添加下载页面机型图片、添加底包信息、特定 Recovery 下载地址、设备硬件参数和安装教程地址等。
1 Like

前排支持,支持魔趣

:+1::+1:

支持魔趣尽快适配Q

emmm你头像有毒。
Android Q都没开源,怎么适配?

之前提交繞了好多路,有這教學照著做就簡單多了

另外我遇到 commit message 需要加入 Signed-off-by 和 Change-Id

這個設置是下面這行嗎?

我當時是用 tortoisegit 這個 GUI 再輸入 commit message 時添加進去的

只用 git commit -a -m “xxxx” 會有 Signed-off 簽名嗎?

還有 windows 環境下要額外設定
git config --global core.autocrlf false
git config --global core.safecrlf false
之前翻車好幾次

gitdir=$(git rev-parse --git-dir); scp -p -P 29418 你的用户名@mokeedev.review:hooks/commit-msg ${gitdir}/hooks/
1 Like

這樣我每次 commit 都會自動加入 Signed-off-by 了嗎?

你把毒杀死了


这个地址包含commit-msg hook,同步下来的仓库每次提交都会自动带签名。
如果是已经下载下来的仓库,需要用导演提供的命令设置commit-msg hook,接下来的提交就会自动带签名了,无需每次提交输入。

1 Like

Signed-off 好像是 GPG 相关的,反正 Gerrit 没要求。

了解,
GUI 會把兩個一起加進來,所以我沒有搞清楚,
感謝

完全替换代码可以不

登录GitHub的时候提示Forbidden。。。
image

这句对repo来说不管用,应该写成
git config --global review.https://mokeedev.review.username “demo-mokee”