请容许我再次重申:对于我们这样的小团队而言,工作效率是团队能否存活下来的重要方面。
让我说的更直白一些:作为实习生,你的工作效率是否达到我的最低要求,直接决定了是否可以留在团队。 工作效率这里是指:第一,是否能够在DDL前完成交付;第二,培养你需要占用的我的时间,是否超过了我自己做这项工作的平摊时间。 平摊时间是指我的时间投入加上以后通过将同类(不需要我再投入时间指导或返工)工作 Offloading 给你而扣除的我的时间的期望(E)。
不管是全职员工还是实习生,我们都是非常强调技术报告能力和组内分享。
对于实习生而言,我的培养原则是「如果不能够报告清楚一项技术内容,那么就不能说真正理解了这项技术内容的内涵」(ref: 原则03 )。
每个实习生平均两周就会被要求进行一次技术报告。刚加入团队的实习生一般是一周一次。
消化理解型的报告形式是,对于 已经有人做过整理或报告的技术内容,进行同样内容的报告 。
前人做过的技术报告的内容,包括:
- 技术演讲(视频)
- 技术演讲的幻灯片(Slides)
- 技术博客文章,内容是完整的教程或者一步一步探索的过程。
- 教程(Tutorial)
消化理解型报告的特点:
- 报告人一定是一开始没有掌握需要报告的知识的。报告所用素材中的知识点的掌握,是报告的目标之一。
- 报告的听众中除了mentor,还有其他的初学者。技术报告的目的是能够让其他的初学者能够更加快速的掌握所需的知识。
- 往往是跟后续的代码开发任务直接相关。
- 一般通过在线视频会议形式进行报告,报告结果会留存作为团队的资料,或作为公开课(MOOC)开放出来。
- 一般从拿到自学任务到进行报告,时间不会超过一周(5天)。超过一周的工作需要进行拆分。
做消化理解型技术报告的注意事项:
- 名誉权和出处。参考原则06。消化理解型的报告基本上不会有新内容创新,都是第三方资料以及进一步检索得到的资料汇总。因此,对于前人工作的引用和致谢就分量更重。
- 所有的资料都需要在PPT的最后给出参考出处。
- 没有出处的不能引用;
- 使用的截图等信息需要给出URL,在那一页引用,就在那一页的下方贴上URL。
- 在做资料检索的时候就养成用一个 txt 文件或备忘录记载出处的习惯。
- 不要漏掉任何 non-trivial 的引用。
- 拿到一个slides或者视频,并不是只看这一个材料,这只是开始。从一个素材出发,根据自己知识背景的不同,要进行不同的检索。例如,V8的Turbofan视频,要理解,就先要理解 JavaScript 语言的一般特点,需要知道 hidden class 到底什么意思,为什么会有 deoptimization。
- 要考虑受众。估计到有人可能不理解的术语和概念,要去查资料补充解释。PPT的字不能太小,颜色不能太刺眼,一页不要放太多内容。
- 最终交付和公开是用PDF的形式。因此不要在PPT中使用特效或者按键触发的特技。
- 默认报告会进行留存,用于后续的团队内部培训,根据需要有可能会以团队名义作为公开课开放。所以请务必注意质量。
- 使用团队指定的PPT模版。
- 第一页统一写上「日期、身份、姓名、邮箱、网址」。例如PLCT,就需要写 「软件所PLCT实验室实习生 某某某」,邮箱写「 https://github.com/isrc-cas 」
- 正式报告前最好提前一天交给mentor做review,提供一些建议。
- 当对外公开发布的时候,作者承担主要责任和荣誉。因此,第一页的名字需要写大一点 :-)
正式的学术论文比较难,需要的背景知识比较多,因此并不算在消化理解型报告中,属于专门的论文讨论型报告。
实习生相关的工作有超过半数是在 GitHub 上公开进行的。 因此,如何熟练的使用 GitHub 的各种功能就显得对于效率的提升尤为重要。
如果是第一天在一个 GitHub 公开仓库上工作,那么遵守 fork-commit-push-PR 流程。具体流程可以 Google 到 GitHub 的官方文档或者其他优秀的教程。
需要注意的是,任何工作最好都不要在已经有的分支上进行。默认应该是每次工作开一个新的分支。
理由是如果是在已有的分支上进行commit(熟练实习生一般是偷懒或者习惯没有养成,新手实习生往往是不知道可以 checkout -b), 那么基本上是「单线程」的工作模式:在 master 分支上 commit 之后, push 到自己的 GitHub remote, 发起 PR,然后就什么都做不了了,等我来处理。
正确做法是每次工作都开一个新的分支来做。具体:
- Clone 下来 repo,切换到 master 或者 develop 分支(具体根据项目约定)。
- 从项目工作约定的分支 checkout -b 一个 local branch,分支名字可以是 issueNNN,对应任务的 id。
- work,commit,work,commit,得到一个 commit list (有时候对应的patches叫 patch set)
- push 到你自己的 GitHub remote 的新分支,注意是新分支,一般是跟本地分支名字相同(to save your time and life)。
- 登录进入 GitHub 网页,看到你的分支,按照提示进行 Pull Request 操作。注意一定要选对目标分支,如果不明白,跟你的mentor询问。
- Reviewer (一般是你的mentor)进行 code review。一般会提一些意见,要求修改。
- 如果要求修改,跳转到 3. 新的修改push到已经发起PR的分支之后不需要重复发起PR。
- 如果被merge,那么恭喜🎉同时要注意,现在开始你的工作流程就不一样了。继续往下看。
OK,现在恭喜你,已经有了被 merge 的 PR。同时有一个坏消息告诉你: 从现在开始你 fork 出来的 repo 已经跟上游的 repo 不一样了。 虽然我曾经惊奇的发现过一个简单粗暴的解决办法【1】但是我并不打算告诉你。
正确的做法如下:
- 进入已经 clone 的 repo。运行 git remote -v。预期看到一个 remote,名字是 origin, URL 是你的 GitHub repo,forked from repo AAA。
- 假设你的repo是从 repo AAA fork 出来的。例如 https://github.com/lazyparser/becoming-a-compiler-engineer-codes 运行 git remote add lazyparser URL。 这一步的作用是添加了一个新的 remote。 remote 的名字可以自己取一个,没有什么需要遵守的规律。
- 运行 git fetch lazyparser 将上游仓库的代码也 clone 一份下来到你的本地机器(跟 origin 同样保存在 .git 目录下)
- 本地创建一个分支,从你计划 push 的 branch。具体 git help branch or git help checkout。你会发现原来这些命令都可以带两个以上参数的。一条命令搞定。
- work,commit,work,commit,得到一个 commit list (有时候对应的patches叫 patch set)
- 【注意】 push 到 你自己的 GitHub remote 的新分支,注意是新分支,一般是跟本地分支名字相同(to save your time and life)。
- 其他都跟第一次类似了。
- 以后,如果PR遇到冲突,表示上游分支已经更新了,你需要更新自己的本地分支已解决冲突。解决方法是 git fetch 然后 git rebase。遇到冲突的时候,用 git status 查看哪些是冲突的,打开,一个个修改。搜索类似 <<<<HEAD 这样的字样。
- 修改(fix)了所有的conflicts之后,用 git rebase --continue 继续 rebase。
- rebase完成之后,push到你自己的remote(一般是 origin)。如果已经发起了PR,那么PR应该自动更新了。
使用SSH的方式下载仓库代码,需要个人在Github的 SSH Keys设置 里配置本机的SSH公钥。
否则无法clone 源码:
$ git clone git@github.com:lazyparser/survival-manual-for-interns.git Cloning into 'survival-manual-for-interns'... Warning: Permanently added the RSA host key for IP address '52.74.223.119' to the list of known hosts. git@github.com: Permission denied (publickey).
具体配置步骤如下:
1. 本地机器上配置SSH
$ ssh-keygen -t rsa -C "1132021192@qq.com" Generating public/private rsa key pair. Enter file in which to save the key (/home/chenjy/.ssh/id_rsa): Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in /home/chenjy/.ssh/id_rsa. Your public key has been saved in /home/chenjy/.ssh/id_rsa.pub. The key fingerprint is: SHA256:aCPtc0lxXkzqlawcjDbxOTo7pgIrY1wS2ig6D4iio8k 1132021192@qq.com The key's randomart image is: +---[RSA 2048]----+ | . . | | = * . | | = O * | | . . o O * | |.o. . = S = | |*.o. + o + | |O oo o * | |X=. . = . | |*E. .. | +----[SHA256]-----+
注:邮箱修改为自己的邮箱,Enter passphrase 默认回车即可。
2. 将公钥复制粘贴到 Github 的个人SSH Keys配置里。 产生的公钥一般为 ~/.ssh/id_rsa.pub
$ cat ~/.ssh/id_rsa.pub ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDa+LNRQuTAjMWZjRZ8d0CK9rZFjZZBQG2Q8UqBZpHQ7GQSBMdhO4mxRYYk/Zb7t7pMj3BpEyOOGKOFXRjic7ibREnki06TQ8LBolRAFDSBv6E4oOS5ei52mwh+NiL2mT7/5GdwZwgR2eDO22MxDRCHObFr2TBHkiThRs9NTi/28UPsy3MluyuPU/0IWZNwcjr1EKRL9qNOh9Ro+8GoEEb23A6sdG2zOjiV/VKiba8so5TqBt9ZFPvjnJtKINUb8TasusC49dSay5paDCJKnDCJQoDIiOn7ggg4ivkan2w9HK4lUK5oNHjQyQRPRiFBF+mm5DJJ7TW03dheOqZq6KPT 1132021192@qq.com
选中公钥复制粘贴到Github SSH Keys设置 的 NEW SSH key 的 key 里即可(Title自己命名)。
3. 启动SSH代理并添加密钥
$ eval `ssh-agent -s` $ ssh-add
最后就可以使用SSH方式下载仓库文件了。比如:
$ git clone git@github.com:lazyparser/survival-manual-for-interns.git
TODO 由实习生遇到问题之后发起PR到这里。
使用中文输入法的时候,用户的ID提示不会在输入 @ 之后自动提示出来。 用英文输入法就不会遇到这个问题。所以在需要 @ 他人的时候, 一种方法是切换到英文输入法,另一种是用中文输入法输入了英文之后, 按一下退格键,这会触发github/gitlab的ID查找功能,给出正确的结果。
比较常见错误是直接写(我要)做什么事情。这是错误的。想象下我每天看所有人的标题的时候能够看出来什么。 要求的做法是
【在X月X日提交YYY形式的交付物/完成YYY】
如果是一个 meta task,也就是说需要分解成不同的具体执行任务, 那么可以在标题的开头加上 [meta] 的字样。
遇到问题以后,需要在y站开issue,简单而清楚的描述你遇到的问题并@你的上级或同事,最好配有截图或运行log以便他人帮助你解决。 注意不要在私下里询问技术问题,因为你遇到的问题别人也可能遇到,养成在y站中提问的好习惯,不仅可以帮助自己解决问题记录问题,也方便了其他实习同学学习参考。不要害怕去提问,问题也是宝贵的财富。发现问题,解决问题你才能变强。
项目运行时往往会产生各种bugs,明明是按说明来的,居然报错了...尝试半天没有解决的你准备向小组报告这个bug, 下面我们说明一下怎样正确报告bugs
- 贴出error log—error log是最直观描述错误的材料,通常debug的过程都需要参考error log来进行,比如缺少安装某个库、多打了一个空格,error log可以直接给出大部分错误产生的原因,有利于其他人快速了解问题,给你修改建议。
- 描述bug出现的过程—一些简单的问题往往会因为没有清晰的描述而变得难以琢磨,“电脑突然黑屏了,进不去系统”,这种问题抛给任何一个专家都是令人头疼的,详细描述bug产生的过程和你做的操作,“更新了显卡驱动,然后电脑突然黑屏了,进不去系统”,更仔细的会描述帮助问题定位更加精确,有时多几个文字就可以大幅减少处理问题需要的时间。
- 提供bug的复现步骤——“能复现的bug都是好bug”,bug的复现步骤往往是判断bug属性的关键,如果bug能够复现,那么大家都可以参与到bug的解决中来,产生不同的思路和尝试,提出不同的解决方法,高效解决问题。(如果不能复现,那么这个bug对你来说是很危险的,请仔细查看有关说明和代码,必要时尝试不同机器。)
- 提供bug截图——无图无真相,请在报告bug时配上bug的截图或照片
学会利用专业平台进行资料搜索与问题交流,站在巨人的肩膀上去看远方。 Google的访问方式请自行百度学习VPS...,喝茶去了....
TBD
压缩和解压缩的文件的时候注意,如果是zip文件,中文文件名可能会有乱码。
中文 windows 默认会使用 GBK 编码文件名,macOS 和 Linux 使用 UTF8。
解决方法在 Linux 下是使用可以指定文件名编码格式的解压命令行工具。
FIXME: macOS 下的我还没有找到。
所以保守的建议是:不要使用中文文件名,使用英文名。
URL 是浏览器跟WWW服务器之间的通信协议。
URL 中从问号开始的部分,参数,这部分参数,有时候是用来跟踪用户会话,而不是用来唯一标识资源的。
例如如果直接在B站搜索视频,可以得到类似
https://www.bilibili.com/video/av83277184?from=search&seid=1289633595657602924
这样的链接。而实际上在B站,问号和问号后面的是不需要的,可以改成
https://www.bilibili.com/video/av83277184
在内部系统的时候贴的可以更加简洁。而对于B站而言,有一个约定俗称的编号系统就是av号,可以进一步所见为
av83277184
就足够唯一的表示出来要指称的对象了。在满足【原则08】的基础上做到了最大程度的简洁。
日常工作中技术文档的撰写普遍会有中、英文夹杂的情况。在中文输入中,需要注意全角和半角概念。简单而言, ,在英文输入法中,一个英文字符和标点符号 (如 “a”)所占的位置是半角;而在中文输入中,一个汉字所占据 的位置等于两个半角,称为“全角”。默认状态下,英文输入法和中文输入法都是半角的设置,这意味这两种输入法 下所输入的英文字符、符号和数字,都只占据一个“半角”位置。
但是,在中文输入法下,可能会因为快捷键的误操作(如: shift + space )导致全半角误切换,切换后,输入 的英文字符、符号和数字就会被当成汉字处理,看起来占据了“更宽”的位置,例如,从半角的“hello world123” 变成“hello world123”。这看起来是很别扭的,显得很不专业。
因此,在写文档时,一定要注意中文输入法中全、半角的正确使用。
文档中的超链接是用来方便读者深入阅读的,读者要么直接点击链接跳转到相关链接,要么会选择复制粘贴链接 在浏览器中访问。无论是哪一种情况,编辑超链接时,在其前后加上空格都会极大地方便读者。
例如:
这样引用超链接 https://github.com/lazyparser/survival-manual-for-interns 前后加空格是好的做法;
这样引用超链接https://github.com/lazyparser/survival-manual-for-interns前后不加空格不是好的做法。
这样做能够方便编辑器发挥其拼写检查功能。
这样做能够方便编辑器发挥其拼写检查功能。
- 进入系统后安装wsl/wsl2(默认ubuntu18.04),安装方法可以参考这篇官方文档 https://docs.microsoft.com/zh-cn/windows/wsl/install-win10
2. 从开始菜单进入安装好的ubuntu系统中,进入 /etc/apt
更换软件源为国内源(以阿里云软件源为例),并更新软件列表:
$ cd /etc/apt $ vi sources.list //vim中输入 :%:cn.archive.ubuntu:mirrors.aliyun:g ,进行查找替换源 $ sudo apt-get update
3. 安装git、gcc、g++、cmake、make、ninja-build
$ sudo apt-get install git gcc g++ cmake make ninja-build
- 导入自己的ssh密钥(参考上方)
5. 克隆llvm项目到本地(没速度的话尝试去掉https中的s,或者从y站镜像clone)
$ git clone https://github.com/llvm/llvm-project.git
6. 进入llvm-project,准备编译llvm+clang(由于wsl只能运行在系统盘,注意你新电脑的系统盘大小,建议剩余100G)
$ cd llvm-project $ mkdir build $ cd build $ cmake -G "Unix Makefiles" -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi" ../llvm
7. 编译llvm,并记录你的编译用时
$ time make -j4
8. 验证llvm是否安装成功(参考 https://llvm.org/docs/TestingGuide.html )
$ make check
【1】 我曾经指导过的一位实习生,每次要解决跟我(upstream)的repo不一致时候,都是删除自己的 fork,重新 fork。提交了多少次 PR 就删除了多少次。 更好玩的是,他还教会了周围的还处在迷茫中的实习生,一度成为了。
如果是为了带宽问题用了 git clone -depth x 选项,那么 push 到别的remote的时候会遇到
! [remote rejected] master -> master (shallow update not allowed)
解决方法:
我们平时的交流,多数是讲中文,用中文的PPT。但是,现在也越来越多的有英语世界的交流。 有的时候需要用英文演讲英文slides,有的时候是需要提供几页的ppt素材给合作伙伴去国外做技术分享。 因此目前会默认要求所有的对外公开的 slides,最好自己准备全英文的版本。
同时英语要多多练习。说不定哪天实验室就来了英语世界的技术人员交流(常有的事情)。
凡是由于项目交付压力在深夜掉头发的人,都会知道一个自动化的、有效运行的 CI/CD 机制是多么能够抚慰心灵。
以 Clang/LLVM 项目为例,介绍如何自己搭建一个 CI/CD。
0x00 准备工作
首先,代码需要有版本管理。而版本管理现在基本上都是 git。其他管理工具都是蕾丝,只要有命令行工具就OK。
0x01 完成敲回车就一条龙完成的脚本
第二,现在的代码仓库是需要能够被手工构建成功的。如果本身自己手工都还没有构建成功,就先停下来手头的工作, 把这件事情做好。可能有同学会问,有很多组件和函数都还没有实现,怎么办?答案是写一系列的空的函数, 能够保证其他部分可以正常被编译,最低要求是可以被编译构建成功,稍微进一点的要求是可以有一个固定的正确但是没用的返回结果, 让其他部分的构建和测试用例可以完成。
手工可以构建完成之后,接下来就是写到一个脚本里。以 Clang/LLVM 为例,一般的流程是:
# clone # 下载 # checkout # 到正确的分之 # status # 检查是否 clean # git submodule update -r -f --init # 如果有子仓库 mkdir build cd build cmake -DXXX_XX=YYY .. make -j $(nproc) make check # or make test 就是帮助运行回归测试
在一个新开的 terminal 中,完成以上一系列行为。然后用
- ::
- history
命令,复制下来,到一个 build.sh 中,编辑。
简单但是非常重要的一个验证是,切换到另一个目录下,运行 build.sh 看看是否可以成功构建。如果可以,那么进入下一步。
到目前为止,已经有了一个比较好用的脚本,可以方便的进行构建了。
0x02 只有一个 git remote
假设没有 gitlab 也没有 github, 所有人的代码都是(或许有人工 review 后) push 到一个分支,假设是 develop。
那么至少可以做自动化的是推送后的构建测试。写个 for 循环:
# Clone # clone # 下载 # checkout # 到正确的分之 # status # 检查是否 clean while sleep 600 # 每隔10分钟 do git pull ./build.sh || notify-or-send-mail done
就完成了最为简单的推送后CI测试。
没错的,就是这么简单的。没有什么花哨的概念。
核心是: (1)挂了有人看有人及时修复,主线分支不修复好,禁止推送新代码; (2)build.sh 跟这个循环的内容都需要跟项目的开发变更一起更新。
0x03 使用 gitlab CI/CD:写配置文件
有了上一步的脚本之后。剩下来的工作就简单了。
注意,这里的做法跟官方和网上常见的做法都是不同的:这里教授的是 个人或十人以下小团队 从没有 CI 到有 CI 痛苦和麻烦程度最小的途径。 等 CI 建立起来之后,可以再琢磨如何使用更为正统和 docker 的方式来进行。
如果项目有一个 gitlab,那么在项目根目录放一个 .gitlab-ci.yml 这是例子
$ cat .gitlab-ci.yml before_script: build: stage: build tags: - rvv-llvm # 用来指定构建runner的 script: - ./build.sh $ cat build.sh set -e mkdir build cd build cmake -DLLVM_TARGETS_TO_BUILD="X86;RISCV" -DLLVM_ENABLE_PROJECTS="clang;compiler-rt;lld" -G Ninja ../llvm ninja ninja check
0x04 使用 gitlab CI/CD:配置 runner
然后就是设置 gitlab-runner。
首先假设是 linux。别的系统请自己折腾。
按照 https://docs.gitlab.com/runner/install/linux-manually.html 国内请务必直接(可能要海外)下载一个二进制然后就开始干,不要用 apt 来安装,很慢。
之后进入项目的配置主页(需要是 gitlab 这个项目 maintainer 以上的人) 项目页面左下角 Settings - CI/CD 展开 Runners 看到
Set up a specific Runner manually Install GitLab Runner Specify the following URL during the Runner setup: 【你要复制粘贴的网址】 Use the following registration token during setup: 【一会儿要用到的token】
然后按照 https://docs.gitlab.com/runner/install/linux-manually.html 和 https://docs.gitlab.com/runner/register/ 进行注册。注册时候就要用到刚才显示的网址和token。
注意会要求输入 tag 这个 tag 是跟上文中 gitlab-ci 文件中的 tag 对应的。是 runner 的筛选机制。
同时运行环境的时候选择 shell 。注意这里的前提是简单,而且所有有推送权限的人都是可以信任的。 否则有 git 推送权限的人有可能控制 shell 模式 gitlab runner 所在的机器。 当然,这里我们只是个人使用或者微型团队,此类RCE问题不考虑。
之后并不会立即启动,而是需要使用
sudo gitlab-runner start
类似的命令(我记不清了)来启动。启动之后就会看到一些输出了。同时请务必在 tmux 中进行,避免掉线。
接下来就可以从repo页面的左边的 CI/CD - jobs 看到运行结果了。
一开始可能会有一些问题,常见的有:
没有 runner,卡住。(1)查看runner跟gitlab站点的通信时间,是否成功链接上了;(2)查看是否 tag 是匹配的。
脚本执行过程错误。恭喜,这里环境就已经构建好了。根据错误提示,判断是代码提交的bug(那就开issue)或者解决脚本自己的bug(分析、修改)
0x05 搞定了,然后持续维护起来
坏了就赶紧修。这是CI/CD的第一原则。可能也是唯一普遍使用的原则。
TODO 加入更高级和PLCT实际使用部署的环境。
首先,不要慌。 Don't Panic。
第二,使用 GMail,或者其他有着大容量的邮件系统。
第三,使用 GMail 中的 filter 功能,将邮件按照邮件列表进行分类,同时可以选择不丢弃到垃圾邮件箱。这点比较重要。
第四,使用过滤器将自己关注的发信者(例如直接 review 你的 patch 的 maintainers)过滤出来,加上「重要」或者别的标签,方便查询。
第五,使用 Thread 模式来查看邮件。要知道邮件列表做review的时候,常常一个 patch set 是 00/99 这样的规模。而 reviewer 会很仔细的一个一个的回复。使用 flatten 模式按日期排序的话,你会疯掉的。
第六,明确自己的目标,根据标题快速删除掉/已读掉自己不感兴趣的方向的邮件。
第七,对于自己感兴趣的邮件,一定要先阅读 cover letter。也就是编号为 00/xx 的邮件。这是patch作者手工写的对自己的 patch set 的介绍。
第八,使用 Thunderbird 的离线收取模式进行收取,再批量进行删除操作,再上线。这么做其实是由于国内的高墙,导致很多时候批量操作会失败,尤其是当你已经有了一个很大的邮件池子的时候。
第九,每天都要筛选和学习。隔几天一看,如山的规模,就丧失斗志了。
实际上这已经重要到可能超越了技巧,而是形成了规则了。
我们在开发中会借助各种开源软件工具,或者历史遗留代码。不同的代码中会有不同的操作系统要求、libc版本要求、工具链版本要求等。
python 其实也有要求,例如python2和python3的需求。尤其是如果做自动化测试又做深度学习,那么相信你的机器很快就会遇到python环境崩溃的问题了。
这里的一个血泪教训就是所有的python项目都需要使用 venv 来进行,同时注意避免引用系统的python库。
FIXME:或许我需要做一期视频讲座,邀请几位同事来镜头前现场流泪控诉下自己在两个项目交替进行的时候被浪费掉几十个小时的时间的。
有时候我们团队开发需要相互交流代码。最为正式的方式是发起 PR / MR,在标题中注明 RFC 或 WIP。这里 RFC 是 req for comments 的意思。
内部松散一点的代码是可以通过push到个人的repo或者branch上进行交流的。这也是我推荐的方式:在repo中的代码是活的,脱离了repo的代码是死掉的尸体。
在老派的社区中,以及偶尔的外部开发者之间,我们使用邮件或者微信、QQ等形式来发送的时候,可能推荐的方法不好使用。那么这时候就需要用 patch。
patch 可以用 git diff 或者 git format-patch 来生成。
patch set 是对应着一个 branch 上一系列的 commits。用 patch set 组织代码更加清晰,patch更小,容易 review。同时, 要注意,每一个patch都要求不破坏项目的构建和回归测试,不然的话,后续的 git bisect 会造成干扰。
patch 还有一个我们非常看重的要素,就是注明了作者是谁。而直接传递文件,对于调试和确认两遍的代码是不是一致,带来了巨大的隐患。同时,也无法将贡献者的荣耀落于作者之上。
对于员工是严格禁止直接文件来回拷贝的。对于实习生,我们的要求要宽松一些,尽量使用 patch。LV2以下员工如果 git 操作不熟练,或者传递的是 docx 等二进制文档等,那么则通过文件名添加版本号和文件内的修订记录来进行区分和跟踪。
已经提交MR或者PR给 mentor/reviewer 审核的代码,默认是禁止撤销的。尤其是已经被review、留下了评论意见之后。 撤销了。我花时间写的review意见就悬空了。这样对于我在内的任何reviewer都是不礼貌的。 在 upstream 社区做事尤其要注意。 删除自己的仓库也是同样的,会导致评论针对的 branch/commits 丢失,是不礼貌的。
- 出发层进站之后,A28那一头有报销凭证的机器,共5台,平时没有人排队。比B11旁边的自动取票机要好很多(B11那里总是排队)。
- 注意出发层站内的改签窗口(B11旁边),八点前不开门。这是唯一的改签地点。如果到的很早,那么技巧是(1)手机订票;(2)不要取报销凭证;(3)进站前或快到的时候用手机改签,可以改签30分钟后的车次。
- 有广发银行还是某某银行的VIP休息区,可以休息(不过好像人比较满一直)。
- 星巴克在 B28 方向。
- 一定要注意出发层的洗手间是有两个出入口。 带小孩子的同事尤其需要注意,极其容易在厕所出来的时候走散。
- 报销凭证建议出发层刷完身份证之后再取,临上车或下车之后再取,方便改签。
- 从张江高科去虹桥非常远,请至少保持2个小时的通勤时间。地铁稳定在 1.5 小时内到达。
- B站现在可以识别时间轴。在评论中插入类似
23:33
这样的信息就可以得到一个跳转到对应时间的 link。
- 如果是报告的录像记录,那么使用
202011xx - 姓名 - 报告题目
的形式保存,发给我。 - 如果是给行政秘书或者mentor发送,是信息收集性质的,那么不要写
合同.zip
这样的名字,而是用你的名字-具体事项.zip
。这么做的好处是我可以直接从邮件附件中下载,不需要修改文件名。如果同时要收集30个人的信息,每个人都用信息.zip
发给我,我就疯了。
各位有兴趣可以把自己的报告的链接整理整理,像
https://github.com/lazyparser/talks
一样建立一个GitHub repo。将自己做的报告从 PLCT-Open-Reports 中复制一份出来,方便以后写简历或者跟人介绍的时候使用。
我从2016年开始记录的。这个想法来自于 jserv 老师,模仿自 gh/jserv/talks
Tips macOS的输入法记得关闭touchbar推荐,不然会卡顿
下一个技巧,欢迎提交 Pull Requests