标签归档:git

如何将一个commit 变成一系列宣传资源

如何将一个commit 变成一系列宣传资源

作为技术人,对于做 Branding 的事情其实不那么上心,也因为不上心,导致在实际做事情的时候,难免做的不好。

我因为从事过运营,所以有一些经验,这里,分享一下我自己的思路。

以这个 Commit 为例:

这个 Commit 制作了一件事,就是在 GitHub 项目的目录下创建了一个 funding.yml ,从而实现开启 GitHub 的 Sponsor 功能。

第一层思考

那如果我们要将其转换为宣传资源,我们可以这样思考:

  1. 内容形态:这个内容我能不能做成文字类型的,或者是能不能做成视频类型的?

如果可以做成文字类型的,那么可以针对这个 commit 写一篇文章,比如就叫做

如何开启 GitHub 的 Sponsors 功能

如果可以做成视频内容,就可以做成

手把手教你开通 GitHub 的 Sponsors 功能

第二层思考

在第一层思考,我们可以很容易获得一篇文章和一个视频,但我们如果不满足以此,希望获得更多的推广内容,我们要怎么做?

我们可以延展思考一下,GitHub 的 Sponsor 功能是基于特定目录下的 yaml 文件来配置的,那我能不能有一篇文章延展介绍一下这个特定目录下的其他功能?

比如:

  • issue template
  • GitHub Action
  • Pull Request template

这样,我们就从之前的文章中,延展出来了第二层思考,这个时候,我们有了第二个主题,同样,可以延展出一篇文章和一个视频。

第三层思考

在第二层思考中,我延展出来了三个不同的服务,那在这种情况下,我可以再写三篇文章,分别介绍这三种不同的服务

这样,我就喜提三篇文章:

  • 如何使用 GitHub 的 issue template 来规范用户的提交?
  • 如何使用 GitHub 的 Action 来完成应用的自动化
  • 如何使用 GitHub 的 PR template 来规范用户的 PR

以及他们对应的视频。

总结

实际上,只要你愿意去思考「为什么」和「能不能」,很难在计算机领域写干,因为这个领域足够大,足够一个人写一辈子的原创了。你需要做的仅仅是,从你最熟悉的领域,选择一个话题,然后开始写作,不断的延展话题。

此外,如果你想写但又不擅长写作,我之前在 GitChat 和图灵的英子老师一起搞过一个写作课,你可以看看这个网站,我将我们当时的课程内容整理并发布在了互联网上。

使用Prettier、Husky 和 lint-staged 进行 Commit 前处理

在编写代码时,如果你的代码中配置了 ESLint, 而你自己没有运行 ESLint ,可能会导致你的 CI build 失败。因此,在 Commit 前加入格式的修正是很有必要的。

在这篇文章中,我将向你分享,如何使用 Prettier、Husky、Lint-staged 对项目进行 commit 前的格式修复,以及如何配合 Sublime Text 使用。

1. 全局安装 Prettier

想要使用 Prettier 进行格式修复,首先,你需要安装 Prettier ,在命令行中执行如下命令:

npm install --global prettier

2. 在 Sublime Text 中安装 JSPrettier

然后,在 Sublime Text 中使用 Package Control 来安装拓展 JSPrettier

在 Sublime Text 中唤起 Package Control ,执行 Install Pacakge ,并安装其中的 JsPrettier

3. 在项目根目录中添加 Prettier 的配置文件

你可以在项目的根目录下创建一个 .prettierrc 的文件,然后在其中加入配置项目,具体的配置项目可以参考官方的 Options 页面

比如,如下是我的配置文件

{
  "singleQuote": true,
  "semi": false,
  "tabWidth": 2
}

Options 页面地址:https://prettier.io/docs/en/options.html

4. 使用 Sublime 进行格式修正

当你配置好了配置文件以后,打开 Sublime Text,找到一个 JS 文件,并打开,这时,在代码中点击右键,可以看到一个 JSPrettier Format Code ,点击这一项,就可以自动根据你所创建的配置文件,进行界面的修正了。

5. 安装 Husky 和 Lint-staged 配置 Pre-commit 检查

接下来,我们来配置 Precommit 的检查

首先,你需要安装 Husky

cnpm install lint-staged husky --dev --save

安装完成后,修改你的 packages.json 文件,在其中添加如下代码

  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,json,wpy}": ["prettier --write", "git add"]
  }

然后保存。这样,就完成了 precommit 的格式检查了。

6. 测试 commit

接下来,你可以随便修改一个文件,然后执行 git commit操作,你可以看到其会输出如下的内容

可以看到进入 husky 执行 precommit 的修复

参考链接:https://prettier.io/docs/en/precommit.html