Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: change PR template #5123

Merged
merged 3 commits into from
Jul 26, 2022
Merged

chore: change PR template #5123

merged 3 commits into from
Jul 26, 2022

Conversation

LinZexiao
Copy link
Collaborator

Related Issues

involve #4971

Proposed Changes

change PR template

Additional Info

Checklist

Before you mark the PR ready for review, please make sure that:

  • All commits have a clear commit message.
  • The PR title is in the form of of <PR type>: <#issue number> <area>: <change being made>
    • example: fix: #1234 mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, INTERFACE BREAKING CHANGE, CONSENSUS BREAKING, build, chore, ci, docs, misc, perf, refactor, revert, style, test
    • area: venus, venus-messager, venus-miner, venus-gateway, venus-auth, venus-market, venus-sealer, venus-wallet, venus-cluster, api, chain, state, vm, data transfer, mempool, message, block production, multisig, networking, paychan, proving, sealing, wallet
  • This PR has tests for new functionality or change in behaviour
  • If new user-facing features are introduced, clear usage guidelines and / or documentation updates should be included in venus docs or Discussion Tutorials.
  • CI is green

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jul 22, 2022

Codecov Report

Merging #5123 (ca7b1c3) into master (260680b) will increase coverage by 0%.
The diff coverage is n/a.

❗ Current head ca7b1c3 differs from pull request most recent head 628d2ce. Consider uploading reports for the commit 628d2ce to get more accurate results

@@          Coverage Diff           @@
##           master   #5123   +/-   ##
======================================
  Coverage      25%     25%           
======================================
  Files         596     596           
  Lines       65485   65485           
======================================
+ Hits        16591   16594    +3     
+ Misses      46727   46726    -1     
+ Partials     2167    2165    -2     

.github/pull_request_template.md Outdated Show resolved Hide resolved
@0x5459
Copy link
Collaborator

0x5459 commented Jul 22, 2022

自查清单 (Checklist)

在你认为本 PR 满足被审阅的标准之前,需要确保 / Before you mark the PR ready for review, please make sure that:

  • 符合Venus项目管理规范中关于PR的相关标准 / The PR follows the PR standards set out in the Venus project management guidelines
  • 具有清晰明确的 commit message / All commits have a clear commit message.
    修改后的 PR 模版中的自查清单
  • 包含必要的测试用例 / This PR has tests for new functionality or change in behaviour
  • 包含必要的指南或文档 / If new user-facing features are introduced, clear usage guidelines and / or documentation updates should be included
  • 通过必要的检查项 / All checks are green

其中 "包含必要的测试用例", "包含必要的指南或文档" 从语义上来说是本次 PR 包含测试用例和文档才需要勾选,但我觉得这两个改成检查项 "包含必要的测试用例或不需要", "包含必要的指南或文档或不需要",可能更加符合 “自查清单“。

参考案例: ant-design PULL_REQUEST_TEMPLATE CN, ant-design PULL_REQUEST_TEMPLATE EN

@LinZexiao LinZexiao force-pushed the chore/tanlang/PR-template branch from 5191493 to e5b7692 Compare July 22, 2022 09:55
@LinZexiao LinZexiao requested a review from simlecode July 22, 2022 10:00
Copy link
Contributor

@diwufeiwen diwufeiwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

前面提的建议尽快处理后合并,用起来!

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@Fatman13
Copy link
Contributor

小的空格问题。

LinZexiao and others added 2 commits July 26, 2022 09:23
remove blank space

Co-authored-by: Yu <[email protected]>
remove blank space

Co-authored-by: Yu <[email protected]>
Copy link
Contributor

@Fatman13 Fatman13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Fatman13 Fatman13 merged commit 6cf47fd into master Jul 26, 2022
@Fatman13 Fatman13 deleted the chore/tanlang/PR-template branch July 26, 2022 02:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants