Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

docs: 更新了贡献指南和 pr 模板 #193

Merged
merged 6 commits into from
Dec 6, 2022

Conversation

teacher-zhou
Copy link
Collaborator

  • ci: 增加了给 pr 打 label 的脚本
  • ci: 增加了 pr 语义检查脚本
  • ci: 增加冲突检查脚本
  • docs: 更新了 contributing.md
  • docs: 更新了 pr 模板

ci: 增加了给 pr 打 label 的脚本
ci: 增加了 pr 语义检查脚本
ci: 增加冲突检查脚本
docs: 更新了 contributing.md
docs: 更新了 pr 模板
@github-actions
Copy link

github-actions bot commented Dec 6, 2022

Unit Test Results

🟢  Tests Passed      |      ⏱️ 3.8s

📝 Total ✔️ Passed ❌ Failed ⚠️ Skipped
93 93 0 0


✏️ updated for commit cfe03fb

@github-actions
Copy link

github-actions bot commented Dec 6, 2022

@github-actions
Copy link

github-actions bot commented Dec 6, 2022

@teacher-zhou teacher-zhou self-assigned this Dec 6, 2022
@github-actions
Copy link

github-actions bot commented Dec 6, 2022

@pull-request-quantifier-deprecated

This PR has 166 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Medium
Size       : +97 -69
Percentile : 53.2%

Total files changed: 7

Change summary by file extension:
.md : +41 -69
.yml : +35 -0
.github/workflows/pr-conflict : +21 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@github-actions
Copy link

github-actions bot commented Dec 6, 2022

@teacher-zhou teacher-zhou merged commit 07cc897 into master Dec 6, 2022
@teacher-zhou teacher-zhou deleted the feature/doc/update_repo_templates branch December 6, 2022 11:51
@github-actions github-actions bot mentioned this pull request Dec 7, 2022
10 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants