GitHub开源项目提交PR
GitHub上如果是自己玩项目比较简单,但如何协作贡献开源项目呢,这就比较有意思了。这里mark下我在贡献开源项目,比如inshellisense积攒的经验。
这里以项目inshellisense为例
fork开源项目,
microsoft/inshellisense
=>alanhg/inshellisense
新建分支,比如
fix/file-template
,进行开发- 有UT的话更新UT,确保测试通过
- 这里不直接使用主分支,是因为主分支用来同步项目更新,避免开发中,原项目有了新commit
- 同时新建分支也可以更好的利用分支名表示在做的修改是feat还是fix等
提交到上游即
alanhg/inshellisense
开源项目
microsoft/inshellisense
如果有更新,拉取更新Sync fork
提交分支
fix/file-template
进行rebase with主干分支,确保最新已同步重新推送到上游
alanhg/inshellisense
发起
Pull Request
,详细描述改动,等待合并- 如果PR review中有任何问题,积极反馈及解决
合并成功即🎉
可以将分支
fix/file-template
删除,切换到主分支,如果还有新的贡献可重新走步骤5进行操作
产品文档编写规范
发布的产品为了让用户能够了解产品如何使用,除了产品中有一些使用介绍外,我们还会单独发布产品文档。这里mark下我在我司编写产品文档时,学习到的一些好的规范。
敬称用
您
而不是你
。截图
不要出现箭头
,但可以出现马赛克和红色选中框
。可以有静态图片和和动态GIF。
文档中可以有一些外部链接。
文档中语句结束要有句号,比如项目列表每个语句结尾应该加句号。
每篇文档开始要有一个总的介绍。
操作步骤从用户登录产品后开始,尽可能包含整个路径,而不是直接从局部开始,避免用户找不到功能入口。
中文文档中,英文需要加
前后空格
。操作名词可以
加粗
。
Pnpm结合Vite进行本地包调试问题
js中str.trim方法
string字符串有trim方法,但trim并非只是处理首尾空格,最近使用时发现有认识上的错误。因此mark下
根据MDN中介绍可以看到,trim处理的是首尾的white space+ line terminators
A new string representing
str
stripped of whitespace from both its beginning and end. Whitespace is defined as white space characters plus line terminators.
而空格只是其中一种white space。那具体有哪些字符呢