github help是github官方针对用户的帮助文档

• github-Basic writing and formatting syntax: 基本的github markdown 语法
• github-Working with advanced formatting: 进阶写法：表格、网址、代码的编写
  • github-Organizing information with tables: 包括了制作表格，表格中格式化，内容的对齐
  • github-Autolinked references and URLs: 基本的网址链接，github ISSUE 和 PR 的链接
  • github-Creating and highlighting code blocks: 基本的代码写法和有高亮的代码写法
  • github-Creating a permanent link to a code snippet: 创建代码永久链接.github可以创建指向特定版本 PR的任何代码行或者代码块链接.这个链接或本项目中以代码行显示,在别的项目中以url的形式显示:
    • 找到代码的位置: 如果是分支中的,直接在分支中找,如果在pr中要先找到对应的pr
    • 如果是单行代码点击行号变成高亮
    • 如果是代码块的话点击首行变成高亮,然后按shift点击最后一行
    • 点击...选择Copy permalink然后粘贴到要使用的地方
• github-EMOJI CHEAT SHEET: github 中使用 emoji 表情
• github help wiki: 关于 github wiki 的写法
  • github-Adding wiki pages via the online interface: 怎么创建新的 wiki page
  • github-Adding and editing wiki pages locally: 怎么在本地编辑 wiki
  • github-Adding images to wikis: wiki中增加图片
  • github-Adding links to wikis: wiki中增加link
  • personal gist-github-wiki-how-to: 介绍作者怎么应用 wiki
  • good wiki example-Boostnote: Boostnote 通过自定义 sidebar 完成了 wiki 的树形结构目录

• 代码过时了,会在源代码上面加一条横线,用两个~包裹 Map map = new HashMap();
• 怎么通过链接跳转到markdown别的标题How to link to a named anchor in Multimarkdown: ## 1.1 Hello World 要转成 [Link](#11-hello-world)
• 引用github中文件的内容,只节选部分内容.如果是单行#L<line-number>如果是多行#L<from-line-number>-L<to-line-number>

• path:app/public: 在app/public directory目录下搜索
• extension:css: 只找 css 文件的代码
• filename:.vimrc commands: 搜索 文件名匹配.vimrc 并且包含commands的代码
• in:path: 路径中包含***的代码
• language:python: python相关项目
• stars:>300: 项目stars数大于300
• size:>200000: 项目大小超过 200kb
• fork:true: 被fork过
• minitest filename:test_helper path:test language:ruby: 在test目录中搜索包含minitest且文件名匹配"test_helper"的ruby代码

github help-Reviewing proposed changes in a pull request是关于如何对别的pr进行review和discuss的部分.其流程大致是(review目前仅支持单行的review,显示的内容是选中行及选中行的前三行):

• 找到pull requests
• 点击Files changed查看别的贡献者进行了什么修改
• 点击Files changed中的修改行号旁边的蓝色评论按钮,此时有suggestion按钮对pr的代码进行建议
• 点击了start review之后review会处在Pending状态,此时可以点击Start a new conversation新增一个讨论,或者点击finish your review完成review
  • start review中写的内容会显示在review的里面(后面还有一个对整个review的总结),review的目的是对代码作出修改意见,或者询问作者为什么要增加这些代码不是别的.
• 在review没有发布(comment)前只对你可见,如果此时不想发布点击cancel review按钮
• 完成了review之后给出建议后需要submit review
• 点击Files changed,在改变的代码中点击Review changes
• 输入comment,总结你对这些意见更改的反馈内容
• 选择review的类型
  • Commnet: 留下常规的反馈,没有明确的统一或者要求.Select Comment to leave general feedback without explicitly approving the changes or requesting additional changes.
  • Approve: 提交review,并且同一合并pr.Select Approve to submit your feedback and approve merging the changes proposed in the pull request.
  • Request changes: 要完成你的反馈才能将pr合并到分支中.Select Request changes to submit feedback that must be addressed before the pull request can be merged.
• 点击Submit review

根据How to select/comment on a range of lines in github pull request得知,目前github暂不支持这个功能

• 如何参加到github社区的讨论,并提交pr的模块: Collaborating with issues and pull requests

github help-Checking out pull requests locally

• git fetch origin pull/ID/head:BRANCHNAME: 将PR拉取到本地
• git checkout BRANCHNAME: 切换到本地分支

如何创建draft-PR: 创建成为draft的PR不能被merge,直到将这个PR的Draft标签去掉

如果一个commit涉及到了多个作者,可以使用github的Co-authored-by功能,详见creating-a-commit-with-multiple-authors,即在commit信息中增加合作者名称Co-authored-by: name <[email protected]>,相关的真实案例见AIRFLOW-5749

在创建PR的时候不要直接创建,而是使用Create Draft Pull Request,的方式创建,就是一个draft PR,如果PR已完成,可以让大家帮忙查看了,就可以使用changing-the-stage-of-a-pull-request修改PR的状态

这里以获取日期为例

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Get current date
        id: date
        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"