Update GH PR Guide Page

未关闭
#73 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
65/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
git, github
领域
documentation

调研方向

从链接的 GitHub PR Guide 页面开始,将其前两个部分与 GitHub 最近的更新进行比较,重点关注截图、审阅者选择和分支保护。使用提供的 squash-merge 和 branch-scoping 指导,添加所要求的“4. Merge Your Pull Request”部分;当这些更新和新部分准确地反映在指南页面上时,工作即告完成。

由索引模型根据 Issue 内容生成。

描述

documentation enhancement

Further updates to the first two sections of the GitHub PR Guide are still needed to align with GitHub's recent updates, though this is more about updating screenshots than actual content. There are a few more features that may be worth highlighting, but a major overhaul is not required.

One more thing to note in that section is actually picking a reviewer or reviewers, i.e., that it should be those that are most familiar with the content after the author and that they must have write access to the repo for it to satisfy branch protections (arguably, this should be covered by most familiar with content).

Additionally (pulling from a discussion in a private repo), let's make a section: "4. Merge Your Pull Request" which will include information about the merging options.

Basics on Squash Merge from @johnbradley's original Two Repo problem draft:

  • Often there are many messy commits that should be reduced to meaningful commits.
  • One easy way to reduce the messy commits into a single commit is using a Squash and merge Pull Request.

Paired with the scope note mentioned in my comment:

We should be sure to emphasize the fact that once a branch is squash merged into main, it can't continue to be used for development, so they should be scoped. Also, that they should be scoped so the squash merge makes sense and can still be used to tell the story (for instance, one feature change and the associated adjustments to tests).

主要语言
Python
星标
1
派生
1
平均合并
6 天 1 小时
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Imageomics/Collaborative-distributed-science-guide 的其他 Issue

查看 Imageomics/Collaborative-distributed-science-guide 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。